Interface NeighborSet
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<NeighborSet>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<NeighborSet>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<NeighborSetKey>
@Generated("mdsal-binding-generator") public interface NeighborSet extends org.opendaylight.yangtools.yang.binding.ChildOf<NeighborSet>, org.opendaylight.yangtools.yang.binding.Augmentable<NeighborSet>, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborSetKey>
Definitions for neighbor setsThis class represents the following YANG schema fragment defined in module openconfig-routing-policy
list neighbor-set { key neighbor-set-name; leaf neighbor-set-name { type string; } list neighbor { key address; leaf address { type inet:ip-address; } } }
The schema path to identify an instance is openconfig-routing-policy/neighbor-set/neighbor-setTo create instances of this class use
NeighborSetBuilder
.- See Also:
NeighborSetBuilder
,NeighborSetKey
-
-
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 NeighborSet thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull NeighborSet obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull NeighborSet obj)
Default implementation ofObject.toString()
contract for this interface.@Nullable Map<NeighborKey,Neighbor>
getNeighbor()
Return neighbor, ornull
if it is not present.String
getNeighborSetName()
Return neighborSetName, ornull
if it is not present.default Class<NeighborSet>
implementedInterface()
NeighborSetKey
key()
default @NonNull Map<NeighborKey,Neighbor>
nonnullNeighbor()
Return neighbor, or an empty list if it is not present.
-
-
-
Method Detail
-
implementedInterface
default Class<NeighborSet> 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 NeighborSet 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:
NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull NeighborSet thisObj, 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:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull NeighborSet 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:
NullPointerException
- ifobj
is null
-
getNeighborSetName
String getNeighborSetName()
Return neighborSetName, ornull
if it is not present.name / label of the neighbor set -- this is used to reference the set in match conditions
- Returns:
java.lang.String
neighborSetName, ornull
if it is not present.
-
getNeighbor
@Nullable Map<NeighborKey,Neighbor> getNeighbor()
Return neighbor, ornull
if it is not present.list of addresses that are part of the neighbor set
- Returns:
java.util.Map
neighbor, ornull
if it is not present.
-
nonnullNeighbor
default @NonNull Map<NeighborKey,Neighbor> nonnullNeighbor()
Return neighbor, or an empty list if it is not present.- Returns:
java.util.Map
neighbor, or an empty list if it is not present.
-
key
NeighborSetKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<NeighborSetKey>
-
-