Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers
Class MeterBandHeaderBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeaderBuilder
-
@Generated("mdsal-binding-generator") public class MeterBandHeaderBuilder extends Object
Class that buildsMeterBandHeader
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
MeterBandHeader createMeterBandHeader(int fooXyzzy, int barBaz) { return new MeterBandHeaderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandHeader, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
MeterBandHeader
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
-
-
Constructor Summary
Constructors Constructor Description MeterBandHeaderBuilder()
Construct an empty builder.MeterBandHeaderBuilder(BandType arg)
Construct a new builder initialized from specifiedBandType
.MeterBandHeaderBuilder(MeterBandHeader base)
Construct a builder initialized with state from specifiedMeterBandHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterBandHeaderBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterBandHeader
build()
A newMeterBandHeader
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBandBurstSize()
Return current value associated with the property corresponding toMeterBandHeader.getBandBurstSize()
.BandId
getBandId()
Return current value associated with the property corresponding toMeterBandHeader.getBandId()
.org.opendaylight.yangtools.yang.common.Uint32
getBandRate()
Return current value associated with the property corresponding toMeterBandHeader.getBandRate()
.BandType
getBandType()
Return current value associated with the property corresponding toBandType.getBandType()
.MeterBandTypes
getMeterBandTypes()
Return current value associated with the property corresponding toMeterBandHeader.getMeterBandTypes()
.MeterBandHeaderKey
key()
Return current value associated with the property corresponding toMeterBandHeader.key()
.MeterBandHeaderBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType)
Remove an augmentation from this builder's product.MeterBandHeaderBuilder
setBandBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMeterBandHeader.getBandBurstSize()
to the specified value.MeterBandHeaderBuilder
setBandId(BandId value)
Set the property corresponding toMeterBandHeader.getBandId()
to the specified value.MeterBandHeaderBuilder
setBandRate(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMeterBandHeader.getBandRate()
to the specified value.MeterBandHeaderBuilder
setBandType(BandType value)
Set the property corresponding toBandType.getBandType()
to the specified value.MeterBandHeaderBuilder
setMeterBandTypes(MeterBandTypes value)
Set the property corresponding toMeterBandHeader.getMeterBandTypes()
to the specified value.MeterBandHeaderBuilder
withKey(MeterBandHeaderKey key)
-
-
-
Constructor Detail
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder()
Construct an empty builder.
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder(BandType arg)
Construct a new builder initialized from specifiedBandType
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.BandType from which the builder should be initialized
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder(MeterBandHeader base)
Construct a builder initialized with state from specifiedMeterBandHeader
.- Parameters:
base
- MeterBandHeader from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MeterBandHeaderKey key()
Return current value associated with the property corresponding toMeterBandHeader.key()
.- Returns:
- current value
-
getBandBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getBandBurstSize()
Return current value associated with the property corresponding toMeterBandHeader.getBandBurstSize()
.- Returns:
- current value
-
getBandId
public BandId getBandId()
Return current value associated with the property corresponding toMeterBandHeader.getBandId()
.- Returns:
- current value
-
getBandRate
public org.opendaylight.yangtools.yang.common.Uint32 getBandRate()
Return current value associated with the property corresponding toMeterBandHeader.getBandRate()
.- Returns:
- current value
-
getBandType
public BandType getBandType()
Return current value associated with the property corresponding toBandType.getBandType()
.- Returns:
- current value
-
getMeterBandTypes
public MeterBandTypes getMeterBandTypes()
Return current value associated with the property corresponding toMeterBandHeader.getMeterBandTypes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public MeterBandHeaderBuilder withKey(MeterBandHeaderKey key)
-
setBandBurstSize
public MeterBandHeaderBuilder setBandBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMeterBandHeader.getBandBurstSize()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBandId
public MeterBandHeaderBuilder setBandId(BandId value)
Set the property corresponding toMeterBandHeader.getBandId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBandRate
public MeterBandHeaderBuilder setBandRate(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMeterBandHeader.getBandRate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBandType
public MeterBandHeaderBuilder setBandType(BandType value)
Set the property corresponding toBandType.getBandType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandTypes
public MeterBandHeaderBuilder setMeterBandTypes(MeterBandTypes value)
Set the property corresponding toMeterBandHeader.getMeterBandTypes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterBandHeaderBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MeterBandHeaderBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public @NonNull MeterBandHeader build()
A newMeterBandHeader
instance.- Returns:
- A new
MeterBandHeader
instance.
-
-