Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.features
Class MeterFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.features.MeterFeaturesBuilder
-
@Generated("mdsal-binding-generator") public class MeterFeaturesBuilder extends Object
Class that buildsMeterFeatures
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:
MeterFeatures createMeterFeatures(int fooXyzzy, int barBaz) { return new MeterFeaturesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterFeatures, 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:
MeterFeatures
- 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 MeterFeaturesBuilder()
Construct an empty builder.MeterFeaturesBuilder(MeterFeatures base)
Construct a builder initialized with state from specifiedMeterFeatures
.MeterFeaturesBuilder(MeterFeatures arg)
Construct a new builder initialized from specifiedMeterFeatures
.MeterFeaturesBuilder(MeterFeaturesReply arg)
Construct a new builder initialized from specifiedMeterFeaturesReply
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterFeaturesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterFeatures
build()
A newMeterFeatures
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMaxBands()
Return current value associated with the property corresponding toMeterFeatures.getMaxBands()
.org.opendaylight.yangtools.yang.common.Uint8
getMaxColor()
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
getMaxMeter()
Return current value associated with the property corresponding toMeterFeatures.getMaxMeter()
.Set<Class<? extends MeterBand>>
getMeterBandSupported()
Return current value associated with the property corresponding toMeterFeatures.getMeterBandSupported()
.Set<Class<? extends MeterCapability>>
getMeterCapabilitiesSupported()
Return current value associated with the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
.MeterFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> augmentationType)
Remove an augmentation from this builder's product.MeterFeaturesBuilder
setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMeterFeatures.getMaxBands()
to the specified value.MeterFeaturesBuilder
setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMeterFeatures.getMaxColor()
to the specified value.MeterFeaturesBuilder
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.MeterFeaturesBuilder
setMeterBandSupported(Set<Class<? extends MeterBand>> values)
Set the property corresponding toMeterFeatures.getMeterBandSupported()
to the specified value.MeterFeaturesBuilder
setMeterCapabilitiesSupported(Set<Class<? extends MeterCapability>> values)
Set the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
to the specified value.
-
-
-
Constructor Detail
-
MeterFeaturesBuilder
public MeterFeaturesBuilder()
Construct an empty builder.
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeaturesReply arg)
Construct a new builder initialized from specifiedMeterFeaturesReply
.- Parameters:
arg
- MeterFeaturesReply from which the builder should be initialized
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeatures arg)
Construct a new builder initialized from specifiedMeterFeatures
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFeatures from which the builder should be initialized
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeatures base)
Construct a builder initialized with state from specifiedMeterFeatures
.- Parameters:
base
- MeterFeatures from which the builder should be initialized
-
-
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:- 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
public Set<Class<? extends MeterBand>> getMeterBandSupported()
Return current value associated with the property corresponding toMeterFeatures.getMeterBandSupported()
.- Returns:
- current value
-
getMeterCapabilitiesSupported
public Set<Class<? extends MeterCapability>> getMeterCapabilitiesSupported()
Return current value associated with the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> 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 MeterFeaturesBuilder 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 MeterFeaturesBuilder 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 MeterFeaturesBuilder 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
public MeterFeaturesBuilder setMeterBandSupported(Set<Class<? extends MeterBand>> values)
Set the property corresponding toMeterFeatures.getMeterBandSupported()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMeterCapabilitiesSupported
public MeterFeaturesBuilder setMeterCapabilitiesSupported(Set<Class<? extends MeterCapability>> values)
Set the property corresponding toMeterFeatures.getMeterCapabilitiesSupported()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MeterFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures> 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 MeterFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> 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 MeterFeatures build()
A newMeterFeatures
instance.- Returns:
- A new
MeterFeatures
instance.
-
-