Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers
Interface MeterBandHeader
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<MeterBandHeader>
,BandType
,org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<MeterBandHeaders>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.KeyAware<MeterBandHeaderKey>
@Generated("mdsal-binding-generator")
public interface MeterBandHeader
extends org.opendaylight.yangtools.yang.binding.ChildOf<MeterBandHeaders>, org.opendaylight.yangtools.yang.binding.Augmentable<MeterBandHeader>, BandType, org.opendaylight.yangtools.yang.binding.KeyAware<MeterBandHeaderKey>
This class represents the following YANG schema fragment defined in module opendaylight-meter-types
list meter-band-header { key band-id; leaf band-id { type band-id; } container meter-band-types { leaf flags { type meter-band-type; } } leaf band-rate { type uint32; } leaf band-burst-size { type uint32; } uses band-type; }
To create instances of this class use MeterBandHeaderBuilder
.
- 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 MeterBandHeader thisObj, Object obj) Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode
(@NonNull MeterBandHeader obj) Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString
(@NonNull MeterBandHeader obj) Default implementation ofObject.toString()
contract for this interface.org.opendaylight.yangtools.yang.common.Uint32
Return bandBurstSize, ornull
if it is not present.Return bandId, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return bandRate, ornull
if it is not present.Return meterBandTypes, ornull
if it is not present.default Class<MeterBandHeader>
key()
@NonNull MeterBandTypes
Return meterBandTypes, or an empty instance if it is not present.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return bandBurstSize, guaranteed to be non-null.default @NonNull BandId
Return bandId, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return bandRate, guaranteed to be non-null.Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.BandType
getBandType
-
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 interfaceBandType
- 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
MeterBandHeaderKey key()- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.KeyAware<MeterBandHeaderKey>
-
getBandId
BandId getBandId()Return bandId, ornull
if it is not present.Meter band id
- Returns:
BandId
bandId, ornull
if it is not present.
-
requireBandId
Return bandId, guaranteed to be non-null.Meter band id
- Returns:
BandId
bandId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if bandId is not present
-
getMeterBandTypes
MeterBandTypes getMeterBandTypes()Return meterBandTypes, ornull
if it is not present.- Returns:
MeterBandTypes
meterBandTypes, ornull
if it is not present.
-
nonnullMeterBandTypes
@NonNull MeterBandTypes nonnullMeterBandTypes()Return meterBandTypes, or an empty instance if it is not present.- Returns:
MeterBandTypes
meterBandTypes, or an empty instance if it is not present.
-
getBandRate
org.opendaylight.yangtools.yang.common.Uint32 getBandRate()Return bandRate, ornull
if it is not present.Rate for this band
- Returns:
Uint32
bandRate, ornull
if it is not present.
-
requireBandRate
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBandRate()Return bandRate, guaranteed to be non-null.Rate for this band
- Returns:
Uint32
bandRate, guaranteed to be non-null.- Throws:
NoSuchElementException
- if bandRate is not present
-
getBandBurstSize
org.opendaylight.yangtools.yang.common.Uint32 getBandBurstSize()Return bandBurstSize, ornull
if it is not present.Size of bursts
- Returns:
Uint32
bandBurstSize, ornull
if it is not present.
-
requireBandBurstSize
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBandBurstSize()Return bandBurstSize, guaranteed to be non-null.Size of bursts
- Returns:
Uint32
bandBurstSize, guaranteed to be non-null.- Throws:
NoSuchElementException
- if bandBurstSize is not present
-