Class MeterBandExperimenterBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.experimenter._case.MeterBandExperimenterBuilder
Class that builds
MeterBandExperimenter
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:
MeterBandExperimenter createMeterBandExperimenter(int fooXyzzy, int barBaz) {
return new MeterBandExperimenterBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MeterBandExperimenter, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMeterBandExperimenter
.Construct a new builder initialized from specifiedMeterBandCommons
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MeterBandExperimenter
build()
A newMeterBandExperimenter
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toMeterBandCommons.getBurstSize()
.org.opendaylight.yangtools.yang.common.Uint32
getRate()
Return current value associated with the property corresponding toMeterBandCommons.getRate()
.getType()
Return current value associated with the property corresponding toMeterBandCommons.getType()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter>> augmentationType) Remove an augmentation from this builder's product.setBurstSize
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMeterBandCommons.getBurstSize()
to the specified value.setRate
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMeterBandCommons.getRate()
to the specified value.setType
(MeterBandType value) Set the property corresponding toMeterBandCommons.getType()
to the specified value.
-
Constructor Details
-
MeterBandExperimenterBuilder
public MeterBandExperimenterBuilder()Construct an empty builder. -
MeterBandExperimenterBuilder
Construct a new builder initialized from specifiedMeterBandCommons
.- Parameters:
arg
- MeterBandCommons from which the builder should be initialized
-
MeterBandExperimenterBuilder
Construct a builder initialized with state from specifiedMeterBandExperimenter
.- Parameters:
base
- MeterBandExperimenter from which the builder should be initialized
-
-
Method Details
-
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
-
getBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getBurstSize()Return current value associated with the property corresponding toMeterBandCommons.getBurstSize()
.- Returns:
- current value
-
getRate
public org.opendaylight.yangtools.yang.common.Uint32 getRate()Return current value associated with the property corresponding toMeterBandCommons.getRate()
.- Returns:
- current value
-
getType
Return current value associated with the property corresponding toMeterBandCommons.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter>> 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
-
setBurstSize
public MeterBandExperimenterBuilder setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMeterBandCommons.getBurstSize()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRate
Set the property corresponding toMeterBandCommons.getRate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
Set the property corresponding toMeterBandCommons.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterBandExperimenterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter> 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 MeterBandExperimenterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenter>> 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
A newMeterBandExperimenter
instance.- Returns:
- A new
MeterBandExperimenter
instance.
-