Interface StringTlv

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<StringTlv>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<StringTlv>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Tlv

    @Generated("mdsal-binding-generator")
    public interface StringTlv
    extends org.opendaylight.yangtools.yang.binding.ChildOf<StringTlv>, org.opendaylight.yangtools.yang.binding.Augmentable<StringTlv>, Tlv
    Type = 0: String. The Information field contains a free-form UTF-8 string whose length is given by the Information Length field. Inclusion of this TLV is optional. Multiple String TLVs MAY be included in the message.

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

     container string-tlv {
       uses tlv;
       leaf string-info {
         type string;
       }
     }
     
    The schema path to identify an instance is bmp-messagestring-tlvstring-tlv

    To create instances of this class use StringTlvBuilder.

    See Also:
    StringTlvBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<StringTlv> 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 StringTlv 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 StringTlv 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 StringTlv 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
      • getStringInfo

        String getStringInfo()
        Return stringInfo, or null if it is not present.
        Returns:
        String stringInfo, or null if it is not present.
      • requireStringInfo

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