Interface InstanceId
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<InstanceId>
,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 InstanceId extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<InstanceId>
Instance ID LCAF type.This class represents the following YANG schema fragment defined in module ietf-lisp-address-types
container instance-id { when "../address-type = 'laddr:instance-id-lcaf'" { } leaf iid { type instance-id-type; } leaf mask-length { type uint8; } leaf address { type simple-address; } }
To create instances of this class use
InstanceIdBuilder
.- See Also:
InstanceIdBuilder
-
-
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.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull InstanceId thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull InstanceId obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull InstanceId obj)
Default implementation ofObject.toString()
contract for this interface.SimpleAddress
getAddress()
Return address, ornull
if it is not present.InstanceIdType
getIid()
Return iid, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
getMaskLength()
Return maskLength, ornull
if it is not present.default java.lang.Class<InstanceId>
implementedInterface()
default @NonNull SimpleAddress
requireAddress()
Return address, guaranteed to be non-null.default @NonNull InstanceIdType
requireIid()
Return iid, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
requireMaskLength()
Return maskLength, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<InstanceId> 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 InstanceId 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 InstanceId 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 InstanceId 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
-
getIid
InstanceIdType getIid()
Return iid, ornull
if it is not present.Instance ID value.
- Returns:
InstanceIdType
iid, ornull
if it is not present.
-
requireIid
default @NonNull InstanceIdType requireIid()
Return iid, guaranteed to be non-null.Instance ID value.
- Returns:
InstanceIdType
iid, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if iid is not present
-
getMaskLength
org.opendaylight.yangtools.yang.common.Uint8 getMaskLength()
Return maskLength, ornull
if it is not present.Mask length.
- Returns:
Uint8
maskLength, ornull
if it is not present.
-
requireMaskLength
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireMaskLength()
Return maskLength, guaranteed to be non-null.Mask length.
- Returns:
Uint8
maskLength, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if maskLength is not present
-
getAddress
SimpleAddress getAddress()
Return address, ornull
if it is not present.AFI address.
- Returns:
SimpleAddress
address, ornull
if it is not present.
-
requireAddress
default @NonNull SimpleAddress requireAddress()
Return address, guaranteed to be non-null.AFI address.
- Returns:
SimpleAddress
address, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if address is not present
-
-