Class FlatBatchRemoveMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.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>
public class FlatBatchRemoveMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveMeter>
Class that buildsFlatBatchRemoveMeterBuilder
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:
FlatBatchRemoveMeterBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchRemoveMeterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchRemoveMeterBuilder, 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:
FlatBatchRemoveMeterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchRemoveMeterBuilder()
FlatBatchRemoveMeterBuilder(FlatBatchRemoveMeter base)
FlatBatchRemoveMeterBuilder(Meter arg)
FlatBatchRemoveMeterBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchRemoveMeterBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.FlatBatchRemoveMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchRemoveMeter
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
getMeterName()
Boolean
isBarrier()
FlatBatchRemoveMeterKey
key()
FlatBatchRemoveMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchRemoveMeterBuilder
setBarrier(Boolean value)
FlatBatchRemoveMeterBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.FlatBatchRemoveMeterBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveMeterBuilder
setContainerName(String value)
FlatBatchRemoveMeterBuilder
setFlags(MeterFlags value)
FlatBatchRemoveMeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
FlatBatchRemoveMeterBuilder
setMeterId(MeterId value)
FlatBatchRemoveMeterBuilder
setMeterName(String value)
FlatBatchRemoveMeterBuilder
withKey(FlatBatchRemoveMeterKey key)
-
-
-
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:- 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
-
key
public FlatBatchRemoveMeterKey key()
-
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()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchRemoveMeterBuilder withKey(FlatBatchRemoveMeterKey key)
-
setBatchOrder
public FlatBatchRemoveMeterBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchRemoveMeterBuilder 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 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)
-
setBarrier
public FlatBatchRemoveMeterBuilder setBarrier(Boolean 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
-
addAugmentation
@Deprecated(forRemoval=true) public FlatBatchRemoveMeterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveMeter> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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>
-
-