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

Interface NameTlv

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<NameTlv>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<NameTlv>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Tlv
@Generated("mdsal-binding-generator") public interface NameTlv extends org.opendaylight.yangtools.yang.binding.ChildOf<NameTlv>, org.opendaylight.yangtools.yang.binding.Augmentable<NameTlv>, Tlv
Type = 2: sysName. The Information field contains a ASCII string whose value MUST be set to be equal to the value of the sysName MIB-II [RFC1213] object. Inclusion of this TLV is mandatory.

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

 container name-tlv {
   uses tlv;
   leaf name {
     type string;
   }
 }

To create instances of this class use NameTlvBuilder.

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 NameTlv thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull NameTlv obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull NameTlv obj)
    Default implementation of Object.toString() contract for this interface.
    String
    getName()
    Return name, or null if it is not present.
    default Class<NameTlv>
    implementedInterface()
     
    default @NonNull String
    requireName()
    Return name, 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<NameTlv> 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 NameTlv 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 NameTlv 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 NameTlv 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

    • getName

      String getName()
      Return name, or null if it is not present.
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null.
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present