Interface CommunitySet
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<CommunitySet>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<CommunitySets>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<CommunitySetKey>
@Generated("mdsal-binding-generator") public interface CommunitySet extends org.opendaylight.yangtools.yang.binding.ChildOf<CommunitySets>, org.opendaylight.yangtools.yang.binding.Augmentable<CommunitySet>, org.opendaylight.yangtools.yang.binding.Identifiable<CommunitySetKey>
Definitions for community setsThis class represents the following YANG schema fragment defined in module openconfig-bgp-policy
list community-set { key community-set-name; leaf community-set-name { type string; } list communities { uses bgp-t:community; } }
To create instances of this class use
CommunitySetBuilder
.- See Also:
CommunitySetBuilder
,CommunitySetKey
-
-
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 CommunitySet thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull CommunitySet obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull CommunitySet obj)
Default implementation ofObject.toString()
contract for this interface.@Nullable List<Communities>
getCommunities()
Return communities, ornull
if it is not present.String
getCommunitySetName()
Return communitySetName, ornull
if it is not present.default Class<CommunitySet>
implementedInterface()
CommunitySetKey
key()
default @NonNull List<Communities>
nonnullCommunities()
Return communities, or an empty list if it is not present.default @NonNull String
requireCommunitySetName()
Return communitySetName, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<CommunitySet> 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 CommunitySet 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 CommunitySet 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 CommunitySet 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
-
key
CommunitySetKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<CommunitySetKey>
-
getCommunitySetName
String getCommunitySetName()
Return communitySetName, ornull
if it is not present.name / label of the community set -- this is used to reference the set in match conditions
- Returns:
String
communitySetName, ornull
if it is not present.
-
requireCommunitySetName
default @NonNull String requireCommunitySetName()
Return communitySetName, guaranteed to be non-null.name / label of the community set -- this is used to reference the set in match conditions
- Returns:
String
communitySetName, guaranteed to be non-null.- Throws:
NoSuchElementException
- if communitySetName is not present
-
getCommunities
@Nullable List<Communities> getCommunities()
Return communities, ornull
if it is not present.members of the community set
- Returns:
List<Communities>
communities, ornull
if it is not present.
-
nonnullCommunities
default @NonNull List<Communities> nonnullCommunities()
Return communities, or an empty list if it is not present.- Returns:
List<Communities>
communities, or an empty list if it is not present.
-
-