Class MultipartReplyMeterFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeaturesBuilder
-
@Generated("mdsal-binding-generator") public class MultipartReplyMeterFeaturesBuilder extends Object
Class that buildsMultipartReplyMeterFeatures
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:
MultipartReplyMeterFeatures createMultipartReplyMeterFeatures(int fooXyzzy, int barBaz) { return new MultipartReplyMeterFeaturesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartReplyMeterFeatures, 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:
MultipartReplyMeterFeatures
- 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 MultipartReplyMeterFeaturesBuilder()
Construct an empty builder.MultipartReplyMeterFeaturesBuilder(MultipartReplyMeterFeatures base)
Construct a builder initialized with state from specifiedMultipartReplyMeterFeatures
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultipartReplyMeterFeaturesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MultipartReplyMeterFeatures
build()
A newMultipartReplyMeterFeatures
instance.MeterBandTypeBitmap
getBandTypes()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getBandTypes()
.MeterFlags
getCapabilities()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getCapabilities()
.org.opendaylight.yangtools.yang.common.Uint8
getMaxBands()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxBands()
.org.opendaylight.yangtools.yang.common.Uint8
getMaxColor()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxColor()
.org.opendaylight.yangtools.yang.common.Uint32
getMaxMeter()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxMeter()
.MultipartReplyMeterFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures>> augmentationType)
Remove an augmentation from this builder's product.MultipartReplyMeterFeaturesBuilder
setBandTypes(MeterBandTypeBitmap value)
Set the property corresponding toMultipartReplyMeterFeatures.getBandTypes()
to the specified value.MultipartReplyMeterFeaturesBuilder
setCapabilities(MeterFlags value)
Set the property corresponding toMultipartReplyMeterFeatures.getCapabilities()
to the specified value.MultipartReplyMeterFeaturesBuilder
setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxBands()
to the specified value.MultipartReplyMeterFeaturesBuilder
setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxColor()
to the specified value.MultipartReplyMeterFeaturesBuilder
setMaxMeter(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxMeter()
to the specified value.
-
-
-
Constructor Detail
-
MultipartReplyMeterFeaturesBuilder
public MultipartReplyMeterFeaturesBuilder()
Construct an empty builder.
-
MultipartReplyMeterFeaturesBuilder
public MultipartReplyMeterFeaturesBuilder(MultipartReplyMeterFeatures base)
Construct a builder initialized with state from specifiedMultipartReplyMeterFeatures
.- Parameters:
base
- MultipartReplyMeterFeatures from which the builder should be initialized
-
-
Method Detail
-
getBandTypes
public MeterBandTypeBitmap getBandTypes()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getBandTypes()
.- Returns:
- current value
-
getCapabilities
public MeterFlags getCapabilities()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getCapabilities()
.- Returns:
- current value
-
getMaxBands
public org.opendaylight.yangtools.yang.common.Uint8 getMaxBands()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxBands()
.- Returns:
- current value
-
getMaxColor
public org.opendaylight.yangtools.yang.common.Uint8 getMaxColor()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxColor()
.- Returns:
- current value
-
getMaxMeter
public org.opendaylight.yangtools.yang.common.Uint32 getMaxMeter()
Return current value associated with the property corresponding toMultipartReplyMeterFeatures.getMaxMeter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures>> 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
-
setBandTypes
public MultipartReplyMeterFeaturesBuilder setBandTypes(MeterBandTypeBitmap value)
Set the property corresponding toMultipartReplyMeterFeatures.getBandTypes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCapabilities
public MultipartReplyMeterFeaturesBuilder setCapabilities(MeterFlags value)
Set the property corresponding toMultipartReplyMeterFeatures.getCapabilities()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxBands
public MultipartReplyMeterFeaturesBuilder setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxBands()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxColor
public MultipartReplyMeterFeaturesBuilder setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxColor()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxMeter
public MultipartReplyMeterFeaturesBuilder setMaxMeter(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMultipartReplyMeterFeatures.getMaxMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartReplyMeterFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures> 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 MultipartReplyMeterFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures>> 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 MultipartReplyMeterFeatures build()
A newMultipartReplyMeterFeatures
instance.- Returns:
- A new
MultipartReplyMeterFeatures
instance.
-
-