Class MeterBandTypesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.meter.band.header.MeterBandTypesBuilder
-
@Generated("mdsal-binding-generator") public class MeterBandTypesBuilder extends Object
Class that buildsMeterBandTypes
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:
MeterBandTypes createMeterBandTypes(int fooXyzzy, int barBaz) { return new MeterBandTypesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBandTypes, 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:
MeterBandTypes
- 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 MeterBandTypesBuilder()
Construct an empty builder.MeterBandTypesBuilder(MeterBandTypes base)
Construct a builder initialized with state from specifiedMeterBandTypes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterBandTypesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterBandTypes
build()
A newMeterBandTypes
instance.MeterBandType
getFlags()
Return current value associated with the property corresponding toMeterBandTypes.getFlags()
.MeterBandTypesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes>> augmentationType)
Remove an augmentation from this builder's product.MeterBandTypesBuilder
setFlags(MeterBandType value)
Set the property corresponding toMeterBandTypes.getFlags()
to the specified value.
-
-
-
Constructor Detail
-
MeterBandTypesBuilder
public MeterBandTypesBuilder()
Construct an empty builder.
-
MeterBandTypesBuilder
public MeterBandTypesBuilder(MeterBandTypes base)
Construct a builder initialized with state from specifiedMeterBandTypes
.- Parameters:
base
- MeterBandTypes from which the builder should be initialized
-
-
Method Detail
-
getFlags
public MeterBandType getFlags()
Return current value associated with the property corresponding toMeterBandTypes.getFlags()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes>> 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
-
setFlags
public MeterBandTypesBuilder setFlags(MeterBandType value)
Set the property corresponding toMeterBandTypes.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterBandTypesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes> 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 MeterBandTypesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandTypes>> 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 MeterBandTypes build()
A newMeterBandTypes
instance.- Returns:
- A new
MeterBandTypes
instance.
-
-