Interface ServicePath
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ServicePath>
,org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,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 ServicePath
extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<ServicePath>
Service Path LCAF type.
This class represents the following YANG schema fragment defined in module ietf-lisp-address-types
container service-path { when "../address-type = 'laddr:service-path-lcaf'" { } leaf service-path-id { type service-path-id-type; } leaf service-index { type uint8; } }
To create instances of this class use ServicePathBuilder
.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final @NonNull org.opendaylight.yangtools.yang.common.QName
YANG identifier of the statement represented by this class. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
bindingEquals
(@NonNull ServicePath thisObj, Object obj) Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode
(@NonNull ServicePath obj) Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString
(@NonNull ServicePath obj) Default implementation ofObject.toString()
contract for this interface.org.opendaylight.yangtools.yang.common.Uint8
Return serviceIndex, ornull
if it is not present.Return servicePathId, ornull
if it is not present.default Class<ServicePath>
default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return serviceIndex, guaranteed to be non-null.default @NonNull ServicePathIdType
Return servicePathId, guaranteed to be non-null.Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations
-
Field Details
-
QNAME
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAMEYANG identifier of the statement represented by this class.
-
-
Method Details
-
implementedInterface
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
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:
NullPointerException
- ifobj
is null
-
bindingEquals
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:
NullPointerException
- ifthisObj
is null
-
bindingToString
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:
NullPointerException
- ifobj
is null
-
getServicePathId
ServicePathIdType getServicePathId()Return servicePathId, ornull
if it is not present.Service path identifier for the path for NSH header
- Returns:
ServicePathIdType
servicePathId, ornull
if it is not present.
-
requireServicePathId
Return servicePathId, guaranteed to be non-null.Service path identifier for the path for NSH header
- Returns:
ServicePathIdType
servicePathId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if servicePathId is not present
-
getServiceIndex
org.opendaylight.yangtools.yang.common.Uint8 getServiceIndex()Return serviceIndex, ornull
if it is not present.Service path index for NSH header
- Returns:
Uint8
serviceIndex, ornull
if it is not present.
-
requireServiceIndex
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireServiceIndex()Return serviceIndex, guaranteed to be non-null.Service path index for NSH header
- Returns:
Uint8
serviceIndex, guaranteed to be non-null.- Throws:
NoSuchElementException
- if serviceIndex is not present
-