Package org.opendaylight.yangtools.yang.common

Enum Class YangVersion

java.lang.Object
java.lang.Enum<YangVersion>
org.opendaylight.yangtools.yang.common.YangVersion
All Implemented Interfaces:
Serializable, Comparable<YangVersion>, Constable
public enum YangVersion extends Enum<YangVersion>
Enumeration of supported YANG versions.

  • Enum Constant Details

    • VERSION_1

      public static final YangVersion VERSION_1
      Version 1, as defined in RFC6020.

    • VERSION_1_1

      public static final YangVersion VERSION_1_1
      Version 1.1, as defined in RFC7950.

  • Method Details

    • values

      public static YangVersion[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static YangVersion valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forString

      public static @Nullable YangVersion forString(@NonNull String str)
      Parse a YANG version from its textual representation.
      Parameters:
      str - String to parse
      Returns:
      YANG version, or null
      Throws:
      NullPointerException - if the string is null

    • ofString

      public static @NonNull YangVersion ofString(@NonNull String str)
      Parse a YANG version from its textual representation.
      Parameters:
      str - String to parse
      Returns:
      YANG version
      Throws:
      NullPointerException - if the string is null
      IllegalArgumentException - if the string is not recognized

    • parse

      @Deprecated public static Optional<YangVersion> parse(@NonNull String str)
      Deprecated.
      Use forString(String) or ofString(String)
      Parse a YANG version from its textual representation.
      Parameters:
      str - String to parse
      Returns:
      An Optional YANG version
      Throws:
      NullPointerException - if the string is null

    • reference

      public @NonNull String reference()
      Return the normative reference defining this YANG version.
      Returns:
      Normative reference.

    • getReference

      @Deprecated(since="11.0.0", forRemoval=true) public @NonNull String getReference()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use reference() instead
      Return the normative reference defining this YANG version.
      Returns:
      Normative reference.

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Enum<YangVersion>