Class FlatBatchAddMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.add.meter._case.FlatBatchAddMeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchAddMeter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchAddMeter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlatBatchAddMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchAddMeter>
Class that buildsFlatBatchAddMeterBuilder
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:
FlatBatchAddMeterBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchAddMeterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchAddMeterBuilder, 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 oportunities, 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:
FlatBatchAddMeterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchAddMeterBuilder()
FlatBatchAddMeterBuilder(FlatBatchAddMeter base)
FlatBatchAddMeterBuilder(Meter arg)
FlatBatchAddMeterBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchAddMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeter>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchAddMeter
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
getMeterName()
Boolean
isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.FlatBatchAddMeterKey
key()
FlatBatchAddMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeter>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchAddMeterBuilder
setBarrier(Boolean value)
FlatBatchAddMeterBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.FlatBatchAddMeterBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchAddMeterBuilder
setContainerName(String value)
FlatBatchAddMeterBuilder
setFlags(MeterFlags value)
FlatBatchAddMeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
FlatBatchAddMeterBuilder
setMeterId(MeterId value)
FlatBatchAddMeterBuilder
setMeterName(String value)
FlatBatchAddMeterBuilder
withKey(FlatBatchAddMeterKey key)
-
-
-
Constructor Detail
-
FlatBatchAddMeterBuilder
public FlatBatchAddMeterBuilder()
-
FlatBatchAddMeterBuilder
public FlatBatchAddMeterBuilder(BatchOrderGrouping arg)
-
FlatBatchAddMeterBuilder
public FlatBatchAddMeterBuilder(Meter arg)
-
FlatBatchAddMeterBuilder
public FlatBatchAddMeterBuilder(FlatBatchAddMeter 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter
- org.opendaylight.yang.gen.v1.urn.opendaylight.service.batch.common.rev160322.BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchAddMeterKey key()
-
getBarrier
public Boolean getBarrier()
-
isBarrier
@Deprecated(forRemoval=true) public final Boolean isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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<FlatBatchAddMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchAddMeterBuilder withKey(FlatBatchAddMeterKey key)
-
setBarrier
public FlatBatchAddMeterBuilder setBarrier(Boolean value)
-
setBatchOrder
public FlatBatchAddMeterBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchAddMeterBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public FlatBatchAddMeterBuilder setContainerName(String value)
-
setFlags
public FlatBatchAddMeterBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public FlatBatchAddMeterBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public FlatBatchAddMeterBuilder setMeterId(MeterId value)
-
setMeterName
public FlatBatchAddMeterBuilder setMeterName(String value)
-
addAugmentation
public FlatBatchAddMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeter> 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 FlatBatchAddMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddMeter>> 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 FlatBatchAddMeter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchAddMeter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchAddMeter,IllegalArgumentException>
-
-