Class MeterFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.MeterFeaturesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterFeatures>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterFeatures,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterFeaturesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterFeatures>
Class that buildsMeterFeaturesBuilder
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:
MeterFeaturesBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterFeaturesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterFeaturesBuilder, 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 oportunities, 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:
MeterFeaturesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterFeaturesBuilder()
MeterFeaturesBuilder(MeterFeatures base)
MeterFeaturesBuilder(MeterFeatures arg)
MeterFeaturesBuilder(MeterFeaturesReply arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterFeaturesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>>
E$$augmentation(Class<E$$> augmentationType)
MeterFeatures
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMaxBands()
org.opendaylight.yangtools.yang.common.Uint8
getMaxColor()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getMaxMeter()
List<Class<? extends MeterBand>>
getMeterBandSupported()
List<Class<? extends MeterCapability>>
getMeterCapabilitiesSupported()
MeterFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> augmentationType)
MeterFeaturesBuilder
setMaxBands(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxBands(Uint8)} instead.MeterFeaturesBuilder
setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
MeterFeaturesBuilder
setMaxColor(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxColor(Uint8)} instead.MeterFeaturesBuilder
setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
MeterFeaturesBuilder
setMaxMeter(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
MeterFeaturesBuilder
setMeterBandSupported(List<Class<? extends MeterBand>> values)
MeterFeaturesBuilder
setMeterCapabilitiesSupported(List<Class<? extends MeterCapability>> values)
-
-
-
Constructor Detail
-
MeterFeaturesBuilder
public MeterFeaturesBuilder()
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeaturesReply arg)
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeatures arg)
-
MeterFeaturesBuilder
public MeterFeaturesBuilder(MeterFeatures 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFeaturesReply
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFeatures
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getMaxBands
public org.opendaylight.yangtools.yang.common.Uint8 getMaxBands()
-
getMaxColor
public org.opendaylight.yangtools.yang.common.Uint8 getMaxColor()
-
getMaxMeter
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getMaxMeter()
-
getMeterCapabilitiesSupported
public List<Class<? extends MeterCapability>> getMeterCapabilitiesSupported()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaxBands
public MeterFeaturesBuilder setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMaxBands
@Deprecated(forRemoval=true) public MeterFeaturesBuilder setMaxBands(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxBands(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMaxColor
public MeterFeaturesBuilder setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMaxColor
@Deprecated(forRemoval=true) public MeterFeaturesBuilder setMaxColor(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxColor(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMaxMeter
public MeterFeaturesBuilder setMaxMeter(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
-
setMeterBandSupported
public MeterFeaturesBuilder setMeterBandSupported(List<Class<? extends MeterBand>> values)
-
setMeterCapabilitiesSupported
public MeterFeaturesBuilder setMeterCapabilitiesSupported(List<Class<? extends MeterCapability>> values)
-
addAugmentation
public MeterFeaturesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures> augmentationValue)
-
removeAugmentation
public MeterFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterFeatures>> augmentationType)
-
build
public MeterFeatures build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterFeatures>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterFeatures,IllegalArgumentException>
-
-