Package org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.update.meters.batch.input
Class BatchUpdateMetersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.update.meters.batch.input.BatchUpdateMetersBuilder
-
@Generated("mdsal-binding-generator") public class BatchUpdateMetersBuilder extends Object
Class that buildsBatchUpdateMeters
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:
BatchUpdateMeters createBatchUpdateMeters(int fooXyzzy, int barBaz) { return new BatchUpdateMetersBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchUpdateMeters, 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:
BatchUpdateMeters
- 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 BatchUpdateMetersBuilder()
Construct an empty builder.BatchUpdateMetersBuilder(BatchMeterInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchMeterInputUpdateGrouping
.BatchUpdateMetersBuilder(BatchUpdateMeters base)
Construct a builder initialized with state from specifiedBatchUpdateMeters
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchUpdateMetersBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BatchUpdateMeters
build()
A newBatchUpdateMeters
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MeterRef
getMeterRef()
Return current value associated with the property corresponding toBatchUpdateMeters.getMeterRef()
.OriginalBatchedMeter
getOriginalBatchedMeter()
Return current value associated with the property corresponding toBatchMeterInputUpdateGrouping.getOriginalBatchedMeter()
.UpdatedBatchedMeter
getUpdatedBatchedMeter()
Return current value associated with the property corresponding toBatchMeterInputUpdateGrouping.getUpdatedBatchedMeter()
.BatchUpdateMetersBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters>> augmentationType)
Remove an augmentation from this builder's product.BatchUpdateMetersBuilder
setMeterRef(MeterRef value)
Set the property corresponding toBatchUpdateMeters.getMeterRef()
to the specified value.BatchUpdateMetersBuilder
setOriginalBatchedMeter(OriginalBatchedMeter value)
Set the property corresponding toBatchMeterInputUpdateGrouping.getOriginalBatchedMeter()
to the specified value.BatchUpdateMetersBuilder
setUpdatedBatchedMeter(UpdatedBatchedMeter value)
Set the property corresponding toBatchMeterInputUpdateGrouping.getUpdatedBatchedMeter()
to the specified value.
-
-
-
Constructor Detail
-
BatchUpdateMetersBuilder
public BatchUpdateMetersBuilder()
Construct an empty builder.
-
BatchUpdateMetersBuilder
public BatchUpdateMetersBuilder(BatchMeterInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchMeterInputUpdateGrouping
.- Parameters:
arg
- BatchMeterInputUpdateGrouping from which the builder should be initialized
-
BatchUpdateMetersBuilder
public BatchUpdateMetersBuilder(BatchUpdateMeters base)
Construct a builder initialized with state from specifiedBatchUpdateMeters
.- Parameters:
base
- BatchUpdateMeters 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
-
getMeterRef
public MeterRef getMeterRef()
Return current value associated with the property corresponding toBatchUpdateMeters.getMeterRef()
.- Returns:
- current value
-
getOriginalBatchedMeter
public OriginalBatchedMeter getOriginalBatchedMeter()
Return current value associated with the property corresponding toBatchMeterInputUpdateGrouping.getOriginalBatchedMeter()
.- Returns:
- current value
-
getUpdatedBatchedMeter
public UpdatedBatchedMeter getUpdatedBatchedMeter()
Return current value associated with the property corresponding toBatchMeterInputUpdateGrouping.getUpdatedBatchedMeter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters>> 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
-
setMeterRef
public BatchUpdateMetersBuilder setMeterRef(MeterRef value)
Set the property corresponding toBatchUpdateMeters.getMeterRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalBatchedMeter
public BatchUpdateMetersBuilder setOriginalBatchedMeter(OriginalBatchedMeter value)
Set the property corresponding toBatchMeterInputUpdateGrouping.getOriginalBatchedMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedBatchedMeter
public BatchUpdateMetersBuilder setUpdatedBatchedMeter(UpdatedBatchedMeter value)
Set the property corresponding toBatchMeterInputUpdateGrouping.getUpdatedBatchedMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BatchUpdateMetersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters> 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 BatchUpdateMetersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateMeters>> 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 BatchUpdateMeters build()
A newBatchUpdateMeters
instance.- Returns:
- A new
BatchUpdateMeters
instance.
-
-