Class UpdateMetersBatchOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.UpdateMetersBatchOutputBuilder
-
@Generated("mdsal-binding-generator") public class UpdateMetersBatchOutputBuilder extends Object
Class that buildsUpdateMetersBatchOutput
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:
UpdateMetersBatchOutput createUpdateMetersBatchOutput(int fooXyzzy, int barBaz) { return new UpdateMetersBatchOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateMetersBatchOutput, 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:
UpdateMetersBatchOutput
- 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 UpdateMetersBatchOutputBuilder()
Construct an empty builder.UpdateMetersBatchOutputBuilder(BatchMeterOutputListGrouping arg)
Construct a new builder initialized from specifiedBatchMeterOutputListGrouping
.UpdateMetersBatchOutputBuilder(UpdateMetersBatchOutput base)
Construct a builder initialized with state from specifiedUpdateMetersBatchOutput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateMetersBatchOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpdateMetersBatchOutput
build()
A newUpdateMetersBatchOutput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<BatchFailedMetersOutputKey,BatchFailedMetersOutput>
getBatchFailedMetersOutput()
Return current value associated with the property corresponding toBatchMeterOutputListGrouping.getBatchFailedMetersOutput()
.UpdateMetersBatchOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput>> augmentationType)
Remove an augmentation from this builder's product.UpdateMetersBatchOutputBuilder
setBatchFailedMetersOutput(Map<BatchFailedMetersOutputKey,BatchFailedMetersOutput> values)
Set the property corresponding toBatchMeterOutputListGrouping.getBatchFailedMetersOutput()
to the specified value.
-
-
-
Constructor Detail
-
UpdateMetersBatchOutputBuilder
public UpdateMetersBatchOutputBuilder()
Construct an empty builder.
-
UpdateMetersBatchOutputBuilder
public UpdateMetersBatchOutputBuilder(BatchMeterOutputListGrouping arg)
Construct a new builder initialized from specifiedBatchMeterOutputListGrouping
.- Parameters:
arg
- BatchMeterOutputListGrouping from which the builder should be initialized
-
UpdateMetersBatchOutputBuilder
public UpdateMetersBatchOutputBuilder(UpdateMetersBatchOutput base)
Construct a builder initialized with state from specifiedUpdateMetersBatchOutput
.- Parameters:
base
- UpdateMetersBatchOutput from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBatchFailedMetersOutput
public Map<BatchFailedMetersOutputKey,BatchFailedMetersOutput> getBatchFailedMetersOutput()
Return current value associated with the property corresponding toBatchMeterOutputListGrouping.getBatchFailedMetersOutput()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput>> 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
-
setBatchFailedMetersOutput
public UpdateMetersBatchOutputBuilder setBatchFailedMetersOutput(Map<BatchFailedMetersOutputKey,BatchFailedMetersOutput> values)
Set the property corresponding toBatchMeterOutputListGrouping.getBatchFailedMetersOutput()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateMetersBatchOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput> 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 UpdateMetersBatchOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMetersBatchOutput>> 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 UpdateMetersBatchOutput build()
A newUpdateMetersBatchOutput
instance.- Returns:
- A new
UpdateMetersBatchOutput
instance.
-
-