Class MeterConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.MeterConfigBuilder
-
@Generated("mdsal-binding-generator") public class MeterConfigBuilder extends Object
Class that buildsMeterConfig
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:
MeterConfig createMeterConfig(int fooXyzzy, int barBaz) { return new MeterConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterConfig, 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:
MeterConfig
- 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
-
-
Constructor Summary
Constructors Constructor Description MeterConfigBuilder()
Construct an empty builder.MeterConfigBuilder(MeterConfig base)
Construct a builder initialized with state from specifiedMeterConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterConfig
build()
A newMeterConfig
instance.List<Bands>
getBands()
Return current value associated with the property corresponding toMeterConfig.getBands()
.MeterFlags
getFlags()
Return current value associated with the property corresponding toMeterConfig.getFlags()
.MeterId
getMeterId()
Return current value associated with the property corresponding toMeterConfig.getMeterId()
.MeterConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig>> augmentationType)
Remove an augmentation from this builder's product.MeterConfigBuilder
setBands(List<Bands> values)
Set the property corresponding toMeterConfig.getBands()
to the specified value.MeterConfigBuilder
setFlags(MeterFlags value)
Set the property corresponding toMeterConfig.getFlags()
to the specified value.MeterConfigBuilder
setMeterId(MeterId value)
Set the property corresponding toMeterConfig.getMeterId()
to the specified value.
-
-
-
Constructor Detail
-
MeterConfigBuilder
public MeterConfigBuilder()
Construct an empty builder.
-
MeterConfigBuilder
public MeterConfigBuilder(MeterConfig base)
Construct a builder initialized with state from specifiedMeterConfig
.- Parameters:
base
- MeterConfig from which the builder should be initialized
-
-
Method Detail
-
getBands
public List<Bands> getBands()
Return current value associated with the property corresponding toMeterConfig.getBands()
.- Returns:
- current value
-
getFlags
public MeterFlags getFlags()
Return current value associated with the property corresponding toMeterConfig.getFlags()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeterConfig.getMeterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBands
public MeterConfigBuilder setBands(List<Bands> values)
Set the property corresponding toMeterConfig.getBands()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setFlags
public MeterConfigBuilder setFlags(MeterFlags value)
Set the property corresponding toMeterConfig.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
public MeterConfigBuilder setMeterId(MeterId value)
Set the property corresponding toMeterConfig.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig> 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 MeterConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterConfig>> 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 @NonNull MeterConfig build()
A newMeterConfig
instance.- Returns:
- A new
MeterConfig
instance.
-
-