Interface KeyValueAddress

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

    @Generated("mdsal-binding-generator")
    public interface KeyValueAddress
    extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<KeyValueAddress>
    Key/Value Address LCAF type.

    This class represents the following YANG schema fragment defined in module ietf-lisp-address-types

     container key-value-address {
       when "../address-type = 'laddr:key-value-address-lcaf'" {
       }
       leaf key {
         type simple-address;
       }
       leaf value {
         type simple-address;
       }
     }
     

    To create instances of this class use KeyValueAddressBuilder.

    See Also:
    KeyValueAddressBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<KeyValueAddress> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull KeyValueAddress 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull KeyValueAddress thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull KeyValueAddress 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:
        java.lang.NullPointerException - if obj is null
      • getKey

        SimpleAddress getKey()
        Return key, or null if it is not present.
             
                 Address as Key.
             
         
        Returns:
        SimpleAddress key, or null if it is not present.
      • requireKey

        default @NonNull SimpleAddress requireKey()
        Return key, guaranteed to be non-null.
             
                 Address as Key.
             
         
        Returns:
        SimpleAddress key, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if key is not present
      • getValue

        SimpleAddress getValue()
        Return value, or null if it is not present.
             
                 Address as Value.
             
         
        Returns:
        SimpleAddress value, or null if it is not present.
      • requireValue

        default @NonNull SimpleAddress requireValue()
        Return value, guaranteed to be non-null.
             
                 Address as Value.
             
         
        Returns:
        SimpleAddress value, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if value is not present