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