Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.key.container

Interface MapRegisterCacheKey

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MapRegisterCacheKey>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MapRegisterCacheKeyContainer>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface MapRegisterCacheKey
extends org.opendaylight.yangtools.yang.binding.ChildOf<MapRegisterCacheKeyContainer>, org.opendaylight.yangtools.yang.binding.Augmentable<MapRegisterCacheKey>
    The lookup key in the Map-Register fast path.

    This class represents the following YANG schema fragment defined in module odl-lisp-proto 

     container map-register-cache-key {
   leaf eid-prefix {
     type binary;
   }
   leaf xtr-id {
     type binary;
   }
   leaf site-id {
     type binary;
   }
 }

    To create instances of this class use MapRegisterCacheKeyBuilder.

    See Also:
    MapRegisterCacheKeyBuilder

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

    • 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<MapRegisterCacheKey> 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 MapRegisterCacheKey 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 MapRegisterCacheKey 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 MapRegisterCacheKey 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

      • getEidPrefix

        byte[] getEidPrefix()
        Return eidPrefix, or null if it is not present. 
             
         The EID prefix stored as binary data
        Returns:
        byte[] eidPrefix, or null if it is not present.

      • requireEidPrefix

        default byte @NonNull [] requireEidPrefix()
        Return eidPrefix, guaranteed to be non-null. 
             
         The EID prefix stored as binary data
        Returns:
        byte[] eidPrefix, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if eidPrefix is not present

      • getXtrId

        byte[] getXtrId()
        Return xtrId, or null if it is not present. 
             
         128 bit xTR identifier.
        Returns:
        byte[] xtrId, or null if it is not present.

      • requireXtrId

        default byte @NonNull [] requireXtrId()
        Return xtrId, guaranteed to be non-null. 
             
         128 bit xTR identifier.
        Returns:
        byte[] xtrId, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if xtrId is not present

      • getSiteId

        byte[] getSiteId()
        Return siteId, or null if it is not present. 
             
         64 bit site identifier.
        Returns:
        byte[] siteId, or null if it is not present.

      • requireSiteId

        default byte @NonNull [] requireSiteId()
        Return siteId, guaranteed to be non-null. 
             
         64 bit site identifier.
        Returns:
        byte[] siteId, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if siteId is not present