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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterBandHeader>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandHeader,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterBandHeaderBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterBandHeader>
Class that buildsMeterBandHeaderBuilder
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:
MeterBandHeaderBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterBandHeaderBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandHeaderBuilder, 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 oportunities, 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:
MeterBandHeaderBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterBandHeaderBuilder()
MeterBandHeaderBuilder(BandType arg)
MeterBandHeaderBuilder(MeterBandHeader base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterBandHeaderBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>>
E$$augmentation(Class<E$$> augmentationType)
MeterBandHeader
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBandBurstSize()
BandId
getBandId()
org.opendaylight.yangtools.yang.common.Uint32
getBandRate()
BandType
getBandType()
MeterBandTypes
getMeterBandTypes()
MeterBandHeaderKey
key()
MeterBandHeaderBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType)
MeterBandHeaderBuilder
setBandBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBandBurstSize(Uint32)} instead.MeterBandHeaderBuilder
setBandBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandHeaderBuilder
setBandId(BandId value)
MeterBandHeaderBuilder
setBandRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBandRate(Uint32)} instead.MeterBandHeaderBuilder
setBandRate(org.opendaylight.yangtools.yang.common.Uint32 value)
MeterBandHeaderBuilder
setBandType(BandType value)
MeterBandHeaderBuilder
setMeterBandTypes(MeterBandTypes value)
MeterBandHeaderBuilder
withKey(MeterBandHeaderKey key)
-
-
-
Constructor Detail
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder()
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder(BandType arg)
-
MeterBandHeaderBuilder
public MeterBandHeaderBuilder(MeterBandHeader base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.BandType
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public MeterBandHeaderKey key()
-
getBandBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getBandBurstSize()
-
getBandId
public BandId getBandId()
-
getBandRate
public org.opendaylight.yangtools.yang.common.Uint32 getBandRate()
-
getBandType
public BandType getBandType()
-
getMeterBandTypes
public MeterBandTypes getMeterBandTypes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MeterBandHeaderBuilder withKey(MeterBandHeaderKey key)
-
setBandBurstSize
public MeterBandHeaderBuilder setBandBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBandBurstSize
@Deprecated(forRemoval=true) public MeterBandHeaderBuilder setBandBurstSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBandBurstSize(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBandId
public MeterBandHeaderBuilder setBandId(BandId value)
-
setBandRate
public MeterBandHeaderBuilder setBandRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBandRate
@Deprecated(forRemoval=true) public MeterBandHeaderBuilder setBandRate(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBandRate(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBandType
public MeterBandHeaderBuilder setBandType(BandType value)
-
setMeterBandTypes
public MeterBandHeaderBuilder setMeterBandTypes(MeterBandTypes value)
-
addAugmentation
public MeterBandHeaderBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader> augmentationValue)
-
removeAugmentation
public MeterBandHeaderBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeader>> augmentationType)
-
build
public MeterBandHeader build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterBandHeader>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterBandHeader,IllegalArgumentException>
-
-