Package org.opendaylight.yangtools.yang.model.api

Enum Class Status

java.lang.Object
java.lang.Enum<Status>
org.opendaylight.yangtools.yang.model.api.Status
All Implemented Interfaces:
Serializable, Comparable<Status>, Constable
@NonNullByDefault public enum Status extends Enum<Status>
Enumeration describing YANG 'status' statement. If no status is specified, the default is CURRENT.

  • Enum Constant Details

    • CURRENT

      public static final Status CURRENT
      CURRENT means that the definition is current and valid.

    • DEPRECATED

      public static final Status DEPRECATED
      DEPRECATED indicates an obsolete definition, but it permits new/ continued implementation in order to foster interoperability with older/existing implementations.

    • OBSOLETE

      public static final Status OBSOLETE
      OBSOLETE means the definition is obsolete and SHOULD NOT be implemented and/or can be removed from implementations.

  • Method Details

    • values

      public static Status[] 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 Status 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

    • argument

      public String argument()
      Returns the YANG status statement argument value corresponding to this object.
      Returns:
      String that corresponds to the YANG status statement argument

    • forArgument

      public static @Nullable Status forArgument(String argument)
      Return a Status for specified status statement argument. This methods returns a null for illegal values. See ofArgument(String) for a version which returns non-null and throws an exception for illegal values.
      Parameters:
      argument - status statement argument
      Returns:
      An enumeration value, or null if specified argument is not valid
      Throws:
      NullPointerException - if argument is null

    • ofArgument

      public static Status ofArgument(String argument)
      Return a Status for specified status statement argument. This methods throws an exception for illegal values. See forArgument(String) for a version which returns a null instead for illegal values.
      Parameters:
      argument - status statement argument
      Returns:
      An enumeration value, or null if specified argument is not valid
      Throws:
      NullPointerException - if argument is null
      IllegalArgumentException - if argument is not a valid status statement argument