Class MeterBandExperimenterCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCaseBuilder
-
@Generated("mdsal-binding-generator") public class MeterBandExperimenterCaseBuilder extends Object
Class that buildsMeterBandExperimenterCase
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:
MeterBandExperimenterCase createMeterBandExperimenterCase(int fooXyzzy, int barBaz) { return new MeterBandExperimenterCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandExperimenterCase, 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:
MeterBandExperimenterCase
- 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 MeterBandExperimenterCaseBuilder()
Construct an empty builder.MeterBandExperimenterCaseBuilder(MeterBandExperimenterCase base)
Construct a builder initialized with state from specifiedMeterBandExperimenterCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterBandExperimenterCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterBandExperimenterCase
build()
A newMeterBandExperimenterCase
instance.MeterBandExperimenter
getMeterBandExperimenter()
Return current value associated with the property corresponding toMeterBandExperimenterCase.getMeterBandExperimenter()
.MeterBandExperimenterCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase>> augmentationType)
Remove an augmentation from this builder's product.MeterBandExperimenterCaseBuilder
setMeterBandExperimenter(MeterBandExperimenter value)
Set the property corresponding toMeterBandExperimenterCase.getMeterBandExperimenter()
to the specified value.
-
-
-
Constructor Detail
-
MeterBandExperimenterCaseBuilder
public MeterBandExperimenterCaseBuilder()
Construct an empty builder.
-
MeterBandExperimenterCaseBuilder
public MeterBandExperimenterCaseBuilder(MeterBandExperimenterCase base)
Construct a builder initialized with state from specifiedMeterBandExperimenterCase
.- Parameters:
base
- MeterBandExperimenterCase from which the builder should be initialized
-
-
Method Detail
-
getMeterBandExperimenter
public MeterBandExperimenter getMeterBandExperimenter()
Return current value associated with the property corresponding toMeterBandExperimenterCase.getMeterBandExperimenter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase>> 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
-
setMeterBandExperimenter
public MeterBandExperimenterCaseBuilder setMeterBandExperimenter(MeterBandExperimenter value)
Set the property corresponding toMeterBandExperimenterCase.getMeterBandExperimenter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterBandExperimenterCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase> 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 MeterBandExperimenterCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandExperimenterCase>> 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 MeterBandExperimenterCase build()
A newMeterBandExperimenterCase
instance.- Returns:
- A new
MeterBandExperimenterCase
instance.
-
-