Class FlatBatchRemoveMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.meter.crud._case.aug.flat.batch.remove.meter._case.FlatBatchRemoveMeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveMeter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveMeter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlatBatchRemoveMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveMeter>
Class that buildsFlatBatchRemoveMeter
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:
FlatBatchRemoveMeter createFlatBatchRemoveMeter(int fooXyzzy, int barBaz) { return new FlatBatchRemoveMeterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchRemoveMeter, 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:
FlatBatchRemoveMeter
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchRemoveMeterBuilder()
FlatBatchRemoveMeterBuilder(FlatBatchRemoveMeter base)
FlatBatchRemoveMeterBuilder(Meter arg)
FlatBatchRemoveMeterBuilder(BatchOrderGrouping arg)
-
Method Summary
-
-
-
Constructor Detail
-
FlatBatchRemoveMeterBuilder
public FlatBatchRemoveMeterBuilder()
-
FlatBatchRemoveMeterBuilder
public FlatBatchRemoveMeterBuilder(BatchOrderGrouping arg)
-
FlatBatchRemoveMeterBuilder
public FlatBatchRemoveMeterBuilder(Meter arg)
-
FlatBatchRemoveMeterBuilder
public FlatBatchRemoveMeterBuilder(FlatBatchRemoveMeter 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:- Meter
- BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchRemoveMeterKey key()
-
getBarrier
public Boolean getBarrier()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchRemoveMeterBuilder withKey(FlatBatchRemoveMeterKey key)
-
setBarrier
public FlatBatchRemoveMeterBuilder setBarrier(Boolean value)
-
setBatchOrder
public FlatBatchRemoveMeterBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setContainerName
public FlatBatchRemoveMeterBuilder setContainerName(String value)
-
setFlags
public FlatBatchRemoveMeterBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public FlatBatchRemoveMeterBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public FlatBatchRemoveMeterBuilder setMeterId(MeterId value)
-
setMeterName
public FlatBatchRemoveMeterBuilder setMeterName(String value)
-
addAugmentation
public FlatBatchRemoveMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter> 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 FlatBatchRemoveMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> 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 FlatBatchRemoveMeter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveMeter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveMeter,IllegalArgumentException>
-
-