Class FlatBatchUpdateMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.meter.crud._case.aug.flat.batch.update.meter._case.FlatBatchUpdateMeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateMeter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateMeter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlatBatchUpdateMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateMeter>
Class that buildsFlatBatchUpdateMeter
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:
FlatBatchUpdateMeter createFlatBatchUpdateMeter(int fooXyzzy, int barBaz) { return new FlatBatchUpdateMeterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchUpdateMeter, 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:
FlatBatchUpdateMeter
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchUpdateMeterBuilder()
FlatBatchUpdateMeterBuilder(FlatBatchUpdateMeter base)
FlatBatchUpdateMeterBuilder(BatchMeterInputUpdateGrouping arg)
FlatBatchUpdateMeterBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatBatchUpdateMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchUpdateMeter
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
OriginalBatchedMeter
getOriginalBatchedMeter()
UpdatedBatchedMeter
getUpdatedBatchedMeter()
FlatBatchUpdateMeterKey
key()
FlatBatchUpdateMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchUpdateMeterBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchUpdateMeterBuilder
setOriginalBatchedMeter(OriginalBatchedMeter value)
FlatBatchUpdateMeterBuilder
setUpdatedBatchedMeter(UpdatedBatchedMeter value)
FlatBatchUpdateMeterBuilder
withKey(FlatBatchUpdateMeterKey key)
-
-
-
Constructor Detail
-
FlatBatchUpdateMeterBuilder
public FlatBatchUpdateMeterBuilder()
-
FlatBatchUpdateMeterBuilder
public FlatBatchUpdateMeterBuilder(BatchOrderGrouping arg)
-
FlatBatchUpdateMeterBuilder
public FlatBatchUpdateMeterBuilder(BatchMeterInputUpdateGrouping arg)
-
FlatBatchUpdateMeterBuilder
public FlatBatchUpdateMeterBuilder(FlatBatchUpdateMeter base)
-
-
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:- BatchMeterInputUpdateGrouping
- BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchUpdateMeterKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getOriginalBatchedMeter
public OriginalBatchedMeter getOriginalBatchedMeter()
-
getUpdatedBatchedMeter
public UpdatedBatchedMeter getUpdatedBatchedMeter()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchUpdateMeterBuilder withKey(FlatBatchUpdateMeterKey key)
-
setBatchOrder
public FlatBatchUpdateMeterBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setOriginalBatchedMeter
public FlatBatchUpdateMeterBuilder setOriginalBatchedMeter(OriginalBatchedMeter value)
-
setUpdatedBatchedMeter
public FlatBatchUpdateMeterBuilder setUpdatedBatchedMeter(UpdatedBatchedMeter value)
-
addAugmentation
public FlatBatchUpdateMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter> 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 FlatBatchUpdateMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateMeter>> 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 FlatBatchUpdateMeter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateMeter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateMeter,IllegalArgumentException>
-
-