Module org.opendaylight.yangtools.yang.common
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 Details

    • RFC6020_YANG_FILE_EXTENSION

      public static final String RFC6020_YANG_FILE_EXTENSION
      YANG File Extension, as defined in RFC6020.
      See Also:

    • RFC6020_YANG_MAC_FILE_TYPE

      public static final String RFC6020_YANG_MAC_FILE_TYPE
      YANG Media Type, as defined in RFC6020.
      See Also:

    • RFC6020_YANG_MEDIA_TYPE

      public static final String RFC6020_YANG_MEDIA_TYPE
      YANG Media Type, as defined in hRFC6020.
      See Also:

    • RFC6020_YANG_NAMESPACE_STRING

      public static final String RFC6020_YANG_NAMESPACE_STRING
      YANG namespace, as defined in https://www.rfc-editor.org/rfc/rfc6020#section-14, in String format.
      See Also:

    • RFC6020_YANG_NAMESPACE

      public static final XMLNamespace RFC6020_YANG_NAMESPACE
      YANG namespace, as defined in https://www.rfc-editor.org/rfc/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:

    • RFC6020_MAC_FILE_TYPE

      public static final String RFC6020_MAC_FILE_TYPE
      YANG Media Type, as defined in RFC6020.
      See Also:

    • RFC6020_YIN_MEDIA_TYPE

      public static final String RFC6020_YIN_MEDIA_TYPE
      YANG Media Type, as defined in RFC6020.
      See Also:

    • RFC6020_YIN_NAMESPACE_STRING

      public static final String RFC6020_YIN_NAMESPACE_STRING
      YIN namespace, as defined in https://www.rfc-editor.org/rfc/rfc6020#section-14, in String format.
      See Also:

    • RFC6020_YIN_NAMESPACE

      public static final XMLNamespace RFC6020_YIN_NAMESPACE
      YIN namespace, as defined in https://www.rfc-editor.org/rfc/rfc6020#section-14, in URI format.

    • RFC6020_YIN_MODULE

      public static final QNameModule RFC6020_YIN_MODULE
      Base QNameModule for all YIN statements.

    • YANG_XPATH_FUNCTIONS_PREFIX

      public static final String YANG_XPATH_FUNCTIONS_PREFIX
      Prefix for YANG-specific XPath functions.
      See Also:

    • NETCONF_NAMESPACE_STRING

      public static final String NETCONF_NAMESPACE_STRING
      NETCONF protocol elements' namespace, as defined in RFC4741 section 3.1, in String format.
      See Also:

    • NETCONF_NAMESPACE

      public static final XMLNamespace NETCONF_NAMESPACE
      NETCONF protocol elements' namespace, as defined in RFC4741 section 3.1, in String format.

    • RFC6241_YANG_MODULE

      public static final QNameModule RFC6241_YANG_MODULE
      NETCONF namespace bound to YANG through ietf-netconf@2011-06-01.yang.

    • BAD_ATTRIBUTE_QNAME

      public static final QName BAD_ATTRIBUTE_QNAME
      bad-attribute, value is the name of the attribute.

    • BAD_ELEMENT_QNAME

      public static final QName BAD_ELEMENT_QNAME
      bad-element, value is the name of the element.

    • BAD_NAMESPACE_QNAME

      public static final QName BAD_NAMESPACE_QNAME
      bad-namespace, value is the name of the namespace.

    • SESSION_ID_QNAME

      public static final QName SESSION_ID_QNAME
      session-id, value the session identifier, as modeled in SessionIdOrZero.

    • ERR_ELEMENT_QNAME

      @Deprecated(since="RFC6241") public static final QName ERR_ELEMENT_QNAME
      Deprecated.

    • NOOP_ELEMENT_QNAME

      @Deprecated(since="RFC6241") public static final QName NOOP_ELEMENT_QNAME
      Deprecated.

    • OK_ELEMENT_QNAME

      @Deprecated(since="RFC6241") public static final QName OK_ELEMENT_QNAME
      Deprecated.

    • MISSING_CHOICE_QNAME

      public static final QName MISSING_CHOICE_QNAME
      missing-choice as defined in RFC6020, section 13.7.

    • NON_UNIQUE_QNAME

      public static final QName NON_UNIQUE_QNAME
      non-unique as defined in RFC6020, section 13.1.

    • YANG_LIBRARY_MODULE_NAME

      public static final String YANG_LIBRARY_MODULE_NAME
      The module name assigned to ietf-yang-library. This constant is required for JSON-like parsers, using module names to reference modules.
      See Also:

    • YANG_LIBRARY_NAMESPACE_STRING

      public static final String YANG_LIBRARY_NAMESPACE_STRING
      The namespace assigned to ietf-yang-library. This constant is required for XML-like parsers, using XML namespaces to reference modules.
      See Also:

    • YANG_LIBRARY_NAMESPACE

      public static final XMLNamespace YANG_LIBRARY_NAMESPACE
      The namespace assigned to ietf-yang-library. This constant is useful for referencing things in a type-safe manner.

    • RFC7895_YANG_MODULE

      public static final QNameModule RFC7895_YANG_MODULE
      ietf-yang-library namespace bound to YANG through ietf-yang-library@2016-06-21.yang.

    • RFC8525_YANG_MODULE

      public static final QNameModule RFC8525_YANG_MODULE
      ietf-yang-library namespace bound to YANG through ietf-yang-library@2019-01-04.yang.

  • Method Details

    • 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