Class MultipartReplyMeterFeaturesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesBuilder
@Generated("mdsal-binding-generator")
public class MultipartReplyMeterFeaturesBuilder
extends Object
Class that builds
MultipartReplyMeterFeatures
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMultipartReplyMeterFeatures
.Construct a new builder initialized from specifiedMeterFeatures
.Construct a new builder initialized from specifiedMeterFeaturesReply
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toMeterFeatures.getMaxBands()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toMeterFeatures.getMaxColor()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
Return current value associated with the property corresponding toMeterFeatures.getMaxMeter()
.Return current value associated with the property corresponding toMeterFeatures.getMeterBandSupported()
.Return current value associated with the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterFeatures>> augmentationType) Remove an augmentation from this builder's product.setMaxBands
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toMeterFeatures.getMaxBands()
to the specified value.setMaxColor
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toMeterFeatures.getMaxColor()
to the specified value.setMaxMeter
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toMeterFeatures.getMaxMeter()
to the specified value.setMeterBandSupported
(Set<MeterBand> values) Set the property corresponding toMeterFeatures.getMeterBandSupported()
to the specified value.Set the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
to the specified value.
-
Constructor Details
-
MultipartReplyMeterFeaturesBuilder
public MultipartReplyMeterFeaturesBuilder()Construct an empty builder. -
MultipartReplyMeterFeaturesBuilder
Construct a new builder initialized from specifiedMeterFeaturesReply
.- Parameters:
arg
- MeterFeaturesReply from which the builder should be initialized
-
MultipartReplyMeterFeaturesBuilder
Construct a new builder initialized from specifiedMeterFeatures
.- Parameters:
arg
- MeterFeatures from which the builder should be initialized
-
MultipartReplyMeterFeaturesBuilder
Construct a builder initialized with state from specifiedMultipartReplyMeterFeatures
.- Parameters:
base
- MultipartReplyMeterFeatures from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMaxBands
public org.opendaylight.yangtools.yang.common.Uint8 getMaxBands()Return current value associated with the property corresponding toMeterFeatures.getMaxBands()
.- Returns:
- current value
-
getMaxColor
public org.opendaylight.yangtools.yang.common.Uint8 getMaxColor()Return current value associated with the property corresponding toMeterFeatures.getMaxColor()
.- Returns:
- current value
-
getMaxMeter
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getMaxMeter()Return current value associated with the property corresponding toMeterFeatures.getMaxMeter()
.- Returns:
- current value
-
getMeterBandSupported
Return current value associated with the property corresponding toMeterFeatures.getMeterBandSupported()
.- Returns:
- current value
-
getMeterCapabilitiesSupported
Return current value associated with the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
.- 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
-
setMaxBands
public MultipartReplyMeterFeaturesBuilder setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toMeterFeatures.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 toMeterFeatures.getMaxColor()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxMeter
public MultipartReplyMeterFeaturesBuilder setMaxMeter(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toMeterFeatures.getMaxMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandSupported
Set the property corresponding toMeterFeatures.getMeterBandSupported()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMeterCapabilitiesSupported
public MultipartReplyMeterFeaturesBuilder setMeterCapabilitiesSupported(Set<MeterCapability> values) Set the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
to the specified value.- Parameters:
values
- 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
A newMultipartReplyMeterFeatures
instance.- Returns:
- A new
MultipartReplyMeterFeatures
instance.
-