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>
@Generated("mdsal-binding-generator") public class BatchRemoveMetersBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchRemoveMeters>
Class that buildsBatchRemoveMeters
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:
BatchRemoveMeters createBatchRemoveMeters(int fooXyzzy, int barBaz) { return new BatchRemoveMetersBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchRemoveMeters, 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:
BatchRemoveMeters
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchRemoveMetersBuilder()
BatchRemoveMetersBuilder(Meter arg)
BatchRemoveMetersBuilder(BatchRemoveMeters base)
-
Method Summary
-
-
-
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:- Meter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BatchRemoveMetersKey key()
-
getBarrier
public Boolean getBarrier()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
getMeterRef
public MeterRef getMeterRef()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveMeters>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchRemoveMetersBuilder withKey(BatchRemoveMetersKey key)
-
setBarrier
public BatchRemoveMetersBuilder setBarrier(Boolean value)
-
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)
-
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
-
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>
-
-