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

Interface DescriptionTlv

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

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

     container description-tlv {
   uses tlv;
   leaf description {
     type string;
   }
 }
    The schema path to identify an instance is bmp-messagedescription-tlvdescription-tlv

    To create instances of this class use DescriptionTlvBuilder.

    See Also:
    DescriptionTlvBuilder

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default Class<DescriptionTlv> implementedInterface()
        Specified by:
        implementedInterface in interface 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 DescriptionTlv 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 DescriptionTlv 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 DescriptionTlv 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

      • getDescription

        String getDescription()
        Return description, or null if it is not present.
        Returns:
        String description, or null if it is not present.

      • requireDescription

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