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

Interface ReasonTlv

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ReasonTlv>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ReasonTlv>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Tlv
@Generated("mdsal-binding-generator") public interface ReasonTlv extends org.opendaylight.yangtools.yang.binding.ChildOf<ReasonTlv>, org.opendaylight.yangtools.yang.binding.Augmentable<ReasonTlv>, Tlv
Type = 1: Reason. The Information field contains a two-byte code indicating the reason the connection was terminated. Some reasons may have further TLVs associated with them. Inclusion of this TLV is not optional.

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

 container reason-tlv {
   uses tlv;
   leaf reason {
     type reason;
   }
 }

To create instances of this class use ReasonTlvBuilder.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull ReasonTlv thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull ReasonTlv obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull ReasonTlv obj)
    Default implementation of Object.toString() contract for this interface.
    Reason
    getReason()
    Return reason, or null if it is not present.
    default Class<ReasonTlv>
    implementedInterface()
     
    default @NonNull Reason
    requireReason()
    Return reason, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<ReasonTlv> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface Tlv

    • bindingHashCode

      static int bindingHashCode(@NonNull ReasonTlv obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull ReasonTlv thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull ReasonTlv obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • getReason

      Reason getReason()
      Return reason, or null if it is not present.
      Returns:
      Reason reason, or null if it is not present.

    • requireReason

      default @NonNull Reason requireReason()
      Return reason, guaranteed to be non-null.
      Returns:
      Reason reason, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if reason is not present