Interface Endpoint
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Endpoint>
,org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Endpoints>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<EndpointKey>
@Generated("mdsal-binding-generator")
public interface Endpoint
extends org.opendaylight.yangtools.yang.binding.ChildOf<Endpoints>, org.opendaylight.yangtools.yang.binding.Augmentable<Endpoint>, org.opendaylight.yangtools.yang.binding.Identifiable<EndpointKey>
A list of the endpoints (interfaces or remote connection points that can be
for this connection point). The active endpoint is selected based on the
precedence that it is configured with
This class represents the following YANG schema fragment defined in module openconfig-network-instance
list endpoint { key endpoint-id; leaf endpoint-id { type leafref { path ../config/endpoint-id; } } container config { uses instance-endpoint-config; } container state { config false; uses instance-endpoint-config; uses instance-endpoint-state; } }
To create instances of this class use EndpointBuilder
.
- 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 Endpoint thisObj, Object obj) Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode
(@NonNull Endpoint obj) Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString
(@NonNull Endpoint obj) Default implementation ofObject.toString()
contract for this interface.Return config, ornull
if it is not present.Return endpointId, ornull
if it is not present.getState()
Return state, ornull
if it is not present.key()
@NonNull Config
Return config, or an empty instance if it is not present.@NonNull State
Return state, or an empty instance if it is not present.default @NonNull String
Return endpointId, 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
isnull
-
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
isnull
-
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
isnull
-
key
EndpointKey key()- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<EndpointKey>
-
getEndpointId
String getEndpointId()Return endpointId, ornull
if it is not present.A pointer to the configured identifier for the endpoint
- Returns:
String
endpointId, ornull
if it is not present.
-
requireEndpointId
Return endpointId, guaranteed to be non-null.A pointer to the configured identifier for the endpoint
- Returns:
String
endpointId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if endpointId is not present
-
getConfig
Config getConfig()Return config, ornull
if it is not present.Configuration parameters relating to the endpoint
- Returns:
Config
config, ornull
if it is not present.
-
nonnullConfig
@NonNull Config nonnullConfig()Return config, or an empty instance if it is not present.- Returns:
Config
config, or an empty instance if it is not present.
-
getState
State getState()Return state, ornull
if it is not present.Operational state parameters relating to the endpoint
- Returns:
State
state, ornull
if it is not present.
-
nonnullState
@NonNull State nonnullState()Return state, or an empty instance if it is not present.- Returns:
State
state, or an empty instance if it is not present.
-