Package org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.remove.meters.batch.input
Class BatchRemoveMetersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.remove.meters.batch.input.BatchRemoveMetersBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchRemoveMeters>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveMeters,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchRemoveMetersBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchRemoveMeters>
Class that buildsBatchRemoveMetersBuilder
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:
BatchRemoveMetersBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchRemoveMetersBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchRemoveMetersBuilder, 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:
BatchRemoveMetersBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchRemoveMetersBuilder()
BatchRemoveMetersBuilder(Meter arg)
BatchRemoveMetersBuilder(BatchRemoveMeters base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchRemoveMetersBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BatchRemoveMetersBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>>
E$$augmentation(Class<E$$> augmentationType)
BatchRemoveMeters
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
getMeterName()
MeterRef
getMeterRef()
Boolean
isBarrier()
BatchRemoveMetersKey
key()
BatchRemoveMetersBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> augmentationType)
Remove an augmentation from this builder's product.BatchRemoveMetersBuilder
setBarrier(Boolean value)
BatchRemoveMetersBuilder
setContainerName(String value)
BatchRemoveMetersBuilder
setFlags(MeterFlags value)
BatchRemoveMetersBuilder
setMeterBandHeaders(MeterBandHeaders value)
BatchRemoveMetersBuilder
setMeterId(MeterId value)
BatchRemoveMetersBuilder
setMeterName(String value)
BatchRemoveMetersBuilder
setMeterRef(MeterRef value)
BatchRemoveMetersBuilder
withKey(BatchRemoveMetersKey key)
-
-
-
Constructor Detail
-
BatchRemoveMetersBuilder
public BatchRemoveMetersBuilder()
-
BatchRemoveMetersBuilder
public BatchRemoveMetersBuilder(Meter arg)
-
BatchRemoveMetersBuilder
public BatchRemoveMetersBuilder(BatchRemoveMeters 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
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchRemoveMetersKey key()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
getMeterRef
public MeterRef getMeterRef()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchRemoveMetersBuilder withKey(BatchRemoveMetersKey key)
-
setContainerName
public BatchRemoveMetersBuilder setContainerName(String value)
-
setFlags
public BatchRemoveMetersBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public BatchRemoveMetersBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public BatchRemoveMetersBuilder setMeterId(MeterId value)
-
setMeterName
public BatchRemoveMetersBuilder setMeterName(String value)
-
setMeterRef
public BatchRemoveMetersBuilder setMeterRef(MeterRef value)
-
setBarrier
public BatchRemoveMetersBuilder setBarrier(Boolean value)
-
addAugmentation
public BatchRemoveMetersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters> 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 BatchRemoveMetersBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters> 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 BatchRemoveMetersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> 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 BatchRemoveMeters build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchRemoveMeters>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveMeters,IllegalArgumentException>
-
-