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

Enum Class DeviateKind

java.lang.Object
java.lang.Enum<DeviateKind>
org.opendaylight.yangtools.yang.model.api.DeviateKind
All Implemented Interfaces:
Serializable, Comparable<DeviateKind>, Constable
@NonNullByDefault public enum DeviateKind extends Enum<DeviateKind>
Enumeration describing deviate YANG statement argument. It defines how the server implementation of the target node deviates from its original definition.

  • Enum Constant Details

    • NOT_SUPPORTED

      public static final DeviateKind NOT_SUPPORTED
      Target node is not implemented by the server.

    • ADD

      public static final DeviateKind ADD
      Server implements target node with additional properties.

    • REPLACE

      public static final DeviateKind REPLACE
      Server implements target node with different properties.

    • DELETE

      public static final DeviateKind DELETE
      Server implements target node without some properties.

  • Method Details

    • values

      public static DeviateKind[] 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 DeviateKind 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 deviate statement argument value corresponding to this object.
      Returns:
      String that corresponds to the YANG deviate statement argument

    • forArgument

      public static @Nullable DeviateKind forArgument(String argument)
      Return a DeviateKind for specified deviate 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 - deviate statement argument
      Returns:
      An enumeration value, or null if specified argument is not valid
      Throws:
      NullPointerException - if argument is null

    • ofArgument

      public static DeviateKind ofArgument(String argument)
      Return a DeviateKind for specified deviate 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 - deviate statement argument
      Returns:
      An enumeration value
      Throws:
      NullPointerException - if argument is null
      IllegalArgumentException - if argument is not a valid deviate statement argument