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