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; } }
The schema path to identify an instance is odl-lisp-protomap-register-cache-key-containermap-register-cache-keyTo 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
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull MapRegisterCacheKey thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull MapRegisterCacheKey obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull MapRegisterCacheKey obj)
Default implementation ofObject.toString()
contract for this interface.byte[]
getEidPrefix()
Return eidPrefix, ornull
if it is not present.byte[]
getSiteId()
Return siteId, ornull
if it is not present.byte[]
getXtrId()
Return xtrId, ornull
if it is not present.default java.lang.Class<MapRegisterCacheKey>
implementedInterface()
default byte @NonNull []
requireEidPrefix()
Return eidPrefix, guaranteed to be non-null.default byte @NonNull []
requireSiteId()
Return siteId, guaranteed to be non-null.default byte @NonNull []
requireXtrId()
Return xtrId, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<MapRegisterCacheKey> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull MapRegisterCacheKey obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull MapRegisterCacheKey thisObj, java.lang.Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
java.lang.NullPointerException
- ifthisObj
is null
-
bindingToString
static java.lang.String bindingToString(@NonNull MapRegisterCacheKey obj)
Default implementation ofObject.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
- ifobj
is null
-
getEidPrefix
byte[] getEidPrefix()
Return eidPrefix, ornull
if it is not present.The EID prefix stored as binary data
- Returns:
byte[]
eidPrefix, ornull
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, ornull
if it is not present.128 bit xTR identifier.
- Returns:
byte[]
xtrId, ornull
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, ornull
if it is not present.64 bit site identifier.
- Returns:
byte[]
siteId, ornull
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
-
-