Class ExperimenterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.ExperimenterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Experimenter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Experimenter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExperimenterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Experimenter>
Class that buildsExperimenter
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:
Experimenter createExperimenter(int fooXyzzy, int barBaz) { return new ExperimenterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Experimenter, 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:
Experimenter
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExperimenterBuilder()
ExperimenterBuilder(Experimenter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperimenterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>>
E$$augmentation(Class<E$$> augmentationType)
Experimenter
build()
org.opendaylight.yangtools.yang.common.Uint32
getExperimenter()
org.opendaylight.yangtools.yang.common.Uint32
getExperimenterBurstSize()
org.opendaylight.yangtools.yang.common.Uint32
getExperimenterRate()
MeterBandType
getExperimenterType()
ExperimenterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> augmentationType)
Remove an augmentation from this builder's product.ExperimenterBuilder
setExperimenter(org.opendaylight.yangtools.yang.common.Uint32 value)
ExperimenterBuilder
setExperimenterBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
ExperimenterBuilder
setExperimenterRate(org.opendaylight.yangtools.yang.common.Uint32 value)
ExperimenterBuilder
setExperimenterType(MeterBandType value)
-
-
-
Constructor Detail
-
ExperimenterBuilder
public ExperimenterBuilder()
-
ExperimenterBuilder
public ExperimenterBuilder(Experimenter base)
-
-
Method Detail
-
getExperimenter
public org.opendaylight.yangtools.yang.common.Uint32 getExperimenter()
-
getExperimenterBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getExperimenterBurstSize()
-
getExperimenterRate
public org.opendaylight.yangtools.yang.common.Uint32 getExperimenterRate()
-
getExperimenterType
public MeterBandType getExperimenterType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> E$$ augmentation(Class<E$$> augmentationType)
-
setExperimenter
public ExperimenterBuilder setExperimenter(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setExperimenterBurstSize
public ExperimenterBuilder setExperimenterBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setExperimenterRate
public ExperimenterBuilder setExperimenterRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setExperimenterType
public ExperimenterBuilder setExperimenterType(MeterBandType value)
-
addAugmentation
public ExperimenterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter> 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 ExperimenterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> 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 Experimenter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Experimenter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Experimenter,IllegalArgumentException>
-
-