Package org.opendaylight.yangtools.yang.common

Class YangConstants

java.lang.Object

org.opendaylight.yangtools.yang.common.YangConstants

@NonNullByDefault
public final class YangConstants
extends Object

Constant definitions present in RFC documents related to the YANG language.

Field Summary

Fields

Modifier and Type	Field	Description
static String	RFC6020_MAC_FILE_TYPE	YANG Media Type, as defined in RFC6020.
static String	RFC6020_YANG_FILE_EXTENSION	YANG File Extension, as defined in RFC6020.
static String	RFC6020_YANG_MAC_FILE_TYPE	YANG Media Type, as defined in RFC6020.
static String	RFC6020_YANG_MEDIA_TYPE	YANG Media Type, as defined in hRFC6020.
static QNameModule	RFC6020_YANG_MODULE	Base QNameModule for all YANG statements.
static URI	RFC6020_YANG_NAMESPACE	YANG namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in URI format.
static String	RFC6020_YANG_NAMESPACE_STRING	YANG namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in String format.
static String	RFC6020_YIN_FILE_EXTENSION	YIN File Extension, as defined in RFC6020.
static String	RFC6020_YIN_MEDIA_TYPE	YANG Media Type, as defined in RFC6020.
static QNameModule	RFC6020_YIN_MODULE	Base QNameModule for all YIN statements.
static URI	RFC6020_YIN_NAMESPACE	YIN namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in URI format.
static String	RFC6020_YIN_NAMESPACE_STRING	YIN namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in String format.
static URI	RFC7950_YANG_LIBRARY_CAPABILITY	YANG Library NETCONF Capability, as defined in https://tools.ietf.org/html/rfc7950#section-16.
static String	YANG_XPATH_FUNCTIONS_PREFIX	Prefix for YANG-specific XPath functions.

Method Summary

Modifier and Type	Method	Description
static QName	operationInputQName(QNameModule module)	Create a QName representing the 'input' statement of an operation (RPC or action) within specified QNameModule.
static QName	operationOutputQName(QNameModule module)	Create a QName representing the 'output' statement of an operation (RPC or action) within specified QNameModule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RFC6020_YANG_FILE_EXTENSION

public static final String RFC6020_YANG_FILE_EXTENSION

YANG File Extension, as defined in RFC6020.

See Also:

Constant Field Values

RFC6020_YANG_MAC_FILE_TYPE

public static final String RFC6020_YANG_MAC_FILE_TYPE

YANG Media Type, as defined in RFC6020.

See Also:

Constant Field Values

RFC6020_YANG_MEDIA_TYPE

public static final String RFC6020_YANG_MEDIA_TYPE

YANG Media Type, as defined in hRFC6020.

See Also:

Constant Field Values

RFC6020_YANG_NAMESPACE_STRING

public static final String RFC6020_YANG_NAMESPACE_STRING

YANG namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in String format.

See Also:

Constant Field Values

RFC6020_YANG_NAMESPACE

public static final URI RFC6020_YANG_NAMESPACE

YANG namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in URI format.

RFC6020_YANG_MODULE

public static final QNameModule RFC6020_YANG_MODULE

Base QNameModule for all YANG statements.

RFC6020_YIN_FILE_EXTENSION

public static final String RFC6020_YIN_FILE_EXTENSION

YIN File Extension, as defined in RFC6020.

See Also:

Constant Field Values

RFC6020_MAC_FILE_TYPE

public static final String RFC6020_MAC_FILE_TYPE

YANG Media Type, as defined in RFC6020.

See Also:

Constant Field Values

RFC6020_YIN_MEDIA_TYPE

public static final String RFC6020_YIN_MEDIA_TYPE

YANG Media Type, as defined in RFC6020.

See Also:

Constant Field Values

RFC6020_YIN_NAMESPACE_STRING

public static final String RFC6020_YIN_NAMESPACE_STRING

YIN namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in String format.

See Also:

Constant Field Values

RFC6020_YIN_NAMESPACE

public static final URI RFC6020_YIN_NAMESPACE

YIN namespace, as defined in https://tools.ietf.org/html/rfc6020#section-14, in URI format.

RFC6020_YIN_MODULE

public static final QNameModule RFC6020_YIN_MODULE

Base QNameModule for all YIN statements.

RFC7950_YANG_LIBRARY_CAPABILITY

public static final URI RFC7950_YANG_LIBRARY_CAPABILITY

YANG Library NETCONF Capability, as defined in https://tools.ietf.org/html/rfc7950#section-16.

YANG_XPATH_FUNCTIONS_PREFIX

public static final String YANG_XPATH_FUNCTIONS_PREFIX

Prefix for YANG-specific XPath functions.

See Also:

Constant Field Values

Method Detail

operationInputQName

public static QName operationInputQName(QNameModule module)

Create a QName representing the 'input' statement of an operation (RPC or action) within specified QNameModule.

Parameters:

module - Desired module

Returns:

A QName representing action or RPC input.

Throws:

NullPointerException - if module is null

operationOutputQName

public static QName operationOutputQName(QNameModule module)

Create a QName representing the 'output' statement of an operation (RPC or action) within specified QNameModule.

Parameters:

module - Desired module

Returns:

A QName representing action or RPC output.

Throws:

NullPointerException - if module is null