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