Class FlatBatchAddMeterCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.meter.crud._case.aug.FlatBatchAddMeterCaseBuilder
-
@Generated("mdsal-binding-generator") public class FlatBatchAddMeterCaseBuilder extends Object
Class that buildsFlatBatchAddMeterCase
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:
FlatBatchAddMeterCase createFlatBatchAddMeterCase(int fooXyzzy, int barBaz) { return new FlatBatchAddMeterCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchAddMeterCase, 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:
FlatBatchAddMeterCase
- 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 FlatBatchAddMeterCaseBuilder()
Construct an empty builder.FlatBatchAddMeterCaseBuilder(FlatBatchAddMeterCase base)
Construct a builder initialized with state from specifiedFlatBatchAddMeterCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatBatchAddMeterCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlatBatchAddMeterCase
build()
A newFlatBatchAddMeterCase
instance.Map<FlatBatchAddMeterKey,FlatBatchAddMeter>
getFlatBatchAddMeter()
Return current value associated with the property corresponding toFlatBatchAddMeterCase.getFlatBatchAddMeter()
.FlatBatchAddMeterCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchAddMeterCaseBuilder
setFlatBatchAddMeter(Map<FlatBatchAddMeterKey,FlatBatchAddMeter> values)
Set the property corresponding toFlatBatchAddMeterCase.getFlatBatchAddMeter()
to the specified value.
-
-
-
Constructor Detail
-
FlatBatchAddMeterCaseBuilder
public FlatBatchAddMeterCaseBuilder()
Construct an empty builder.
-
FlatBatchAddMeterCaseBuilder
public FlatBatchAddMeterCaseBuilder(FlatBatchAddMeterCase base)
Construct a builder initialized with state from specifiedFlatBatchAddMeterCase
.- Parameters:
base
- FlatBatchAddMeterCase from which the builder should be initialized
-
-
Method Detail
-
getFlatBatchAddMeter
public Map<FlatBatchAddMeterKey,FlatBatchAddMeter> getFlatBatchAddMeter()
Return current value associated with the property corresponding toFlatBatchAddMeterCase.getFlatBatchAddMeter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase>> 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
-
setFlatBatchAddMeter
public FlatBatchAddMeterCaseBuilder setFlatBatchAddMeter(Map<FlatBatchAddMeterKey,FlatBatchAddMeter> values)
Set the property corresponding toFlatBatchAddMeterCase.getFlatBatchAddMeter()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public FlatBatchAddMeterCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase> 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 FlatBatchAddMeterCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeterCase>> 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 FlatBatchAddMeterCase build()
A newFlatBatchAddMeterCase
instance.- Returns:
- A new
FlatBatchAddMeterCase
instance.
-
-