Interface Bucket
-
- All Superinterfaces:
ActionList
,org.opendaylight.yangtools.yang.binding.Augmentable<Bucket>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Buckets>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<BucketKey>
@Generated("mdsal-binding-generator") public interface Bucket extends org.opendaylight.yangtools.yang.binding.ChildOf<Buckets>, org.opendaylight.yangtools.yang.binding.Augmentable<Bucket>, ActionList, org.opendaylight.yangtools.yang.binding.Identifiable<BucketKey>
This class represents the following YANG schema fragment defined in module opendaylight-group-types
list bucket { key bucket-id; leaf bucket-id { type bucket-id; } leaf weight { type uint16; } leaf watch_port { type uint32; } leaf watch_group { type uint32; } uses action:action-list; }
The schema path to identify an instance is opendaylight-group-typesgroupbucketsbucketTo create instances of this class use
BucketBuilder
.- See Also:
BucketBuilder
,BucketKey
-
-
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 Bucket thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Bucket obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Bucket obj)
Default implementation ofObject.toString()
contract for this interface.BucketId
getBucketId()
Return bucketId, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getWatchGroup()
Return watchGroup, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getWatchPort()
Return watchPort, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint16
getWeight()
Return weight, ornull
if it is not present.default Class<Bucket>
implementedInterface()
BucketKey
key()
default @NonNull BucketId
requireBucketId()
Return bucketId, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
requireWatchGroup()
Return watchGroup, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
requireWatchPort()
Return watchPort, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint16
requireWeight()
Return weight, guaranteed to be non-null.-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.ActionList
getAction, nonnullAction
-
-
-
-
Method Detail
-
implementedInterface
default Class<Bucket> implementedInterface()
- Specified by:
implementedInterface
in interfaceActionList
- 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 Bucket 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 Bucket 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 Bucket 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
BucketKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<BucketKey>
-
getBucketId
BucketId getBucketId()
Return bucketId, ornull
if it is not present.- Returns:
BucketId
bucketId, ornull
if it is not present.
-
requireBucketId
default @NonNull BucketId requireBucketId()
Return bucketId, guaranteed to be non-null.- Returns:
BucketId
bucketId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if bucketId is not present
-
getWeight
org.opendaylight.yangtools.yang.common.Uint16 getWeight()
Return weight, ornull
if it is not present.- Returns:
Uint16
weight, ornull
if it is not present.
-
requireWeight
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireWeight()
Return weight, guaranteed to be non-null.- Returns:
Uint16
weight, guaranteed to be non-null.- Throws:
NoSuchElementException
- if weight is not present
-
getWatchPort
org.opendaylight.yangtools.yang.common.Uint32 getWatchPort()
Return watchPort, ornull
if it is not present.- Returns:
Uint32
watchPort, ornull
if it is not present.
-
requireWatchPort
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireWatchPort()
Return watchPort, guaranteed to be non-null.- Returns:
Uint32
watchPort, guaranteed to be non-null.- Throws:
NoSuchElementException
- if watchPort is not present
-
getWatchGroup
org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
Return watchGroup, ornull
if it is not present.- Returns:
Uint32
watchGroup, ornull
if it is not present.
-
requireWatchGroup
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireWatchGroup()
Return watchGroup, guaranteed to be non-null.- Returns:
Uint32
watchGroup, guaranteed to be non-null.- Throws:
NoSuchElementException
- if watchGroup is not present
-
-