Interface SourceDestKey

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<SourceDestKey>, 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 SourceDestKey
    extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<SourceDestKey>
    Source/Dest LCAF type.

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

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

    To create instances of this class use SourceDestKeyBuilder.

    See Also:
    SourceDestKeyBuilder
    • 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<SourceDestKey> 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 SourceDestKey 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 SourceDestKey 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 SourceDestKey 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
      • getSource

        SimpleAddress getSource()
        Return source, or null if it is not present.
             
                 Source address.
             
         
        Returns:
        SimpleAddress source, or null if it is not present.
      • requireSource

        default @NonNull SimpleAddress requireSource()
        Return source, guaranteed to be non-null.
             
                 Source address.
             
         
        Returns:
        SimpleAddress source, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if source is not present
      • getDest

        SimpleAddress getDest()
        Return dest, or null if it is not present.
             
                 Destination address.
             
         
        Returns:
        SimpleAddress dest, or null if it is not present.
      • requireDest

        default @NonNull SimpleAddress requireDest()
        Return dest, guaranteed to be non-null.
             
                 Destination address.
             
         
        Returns:
        SimpleAddress dest, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if dest is not present