Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120

Enum Class Reason

java.lang.Object
java.lang.Enum<Reason>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Reason
All Implemented Interfaces:
Serializable, Comparable<Reason>, Constable, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.EnumTypeObject, org.opendaylight.yangtools.yang.binding.TypeObject
@Generated("mdsal-binding-generator") public enum Reason extends Enum<Reason> implements org.opendaylight.yangtools.yang.binding.EnumTypeObject

This class represents the following YANG schema fragment defined in module bmp-message 

 typedef reason {
   type enumeration {
     enum administratively-closed {
       value 0;
     }
     enum unspecified {
       value 1;
     }
     enum out-of-resources {
       value 2;
     }
     enum redundant-connection {
       value 3;
     }
     enum permanently-closed {
       value 4;
     }
   }
 }

  • Enum Constant Details

    • AdministrativelyClosed

      public static final Reason AdministrativelyClosed
      Session administratively closed.

    • Unspecified

      public static final Reason Unspecified
      Unspecified reason.

    • OutOfResources

      public static final Reason OutOfResources
      Out of resources. The router has exhausted resources available for the BMP session.

    • RedundantConnection

      public static final Reason RedundantConnection
      Redundant connection. The router has determined that this connection is redundant with another one.

    • PermanentlyClosed

      public static final Reason PermanentlyClosed
      Session permanently administratively closed, will not be re-initiated. Monitoring station should reduce (potentially to 0) the rate at which it attempts reconnection to the monitored router.

  • Method Details

    • values

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

    • getName

      public @NonNull String getName()
      Specified by:
      getName in interface org.opendaylight.yangtools.yang.binding.EnumTypeObject

    • getIntValue

      public int getIntValue()
      Specified by:
      getIntValue in interface org.opendaylight.yangtools.yang.binding.EnumTypeObject

    • forName

      public static @Nullable Reason forName(String name)
      Return the enumeration member whose getName() matches specified assigned name.
      Parameters:
      name - YANG assigned name
      Returns:
      corresponding Reason item, or null if no such item exists
      Throws:
      NullPointerException - if name is null

    • forValue

      public static @Nullable Reason forValue(int intValue)
      Return the enumeration member whose getIntValue() matches specified value.
      Parameters:
      intValue - integer value
      Returns:
      corresponding Reason item, or null if no such item exists

    • ofName

      public static @NonNull Reason ofName(String name)
      Return the enumeration member whose getName() matches specified assigned name.
      Parameters:
      name - YANG assigned name
      Returns:
      corresponding Reason item
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if name does not match any item

    • ofValue

      public static @NonNull Reason ofValue(int intValue)
      Return the enumeration member whose getIntValue() matches specified value.
      Parameters:
      intValue - integer value
      Returns:
      corresponding Reason item
      Throws:
      IllegalArgumentException - if intValue does not match any item