Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.stats.config.request
Class MeterStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.stats.config.request.MeterStatsBuilder
-
@Generated("mdsal-binding-generator") public class MeterStatsBuilder extends Object
Class that buildsMeterStats
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:
MeterStats createMeterStats(int fooXyzzy, int barBaz) { return new MeterStatsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterStats, 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:
MeterStats
- 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 MeterStatsBuilder()
Construct an empty builder.MeterStatsBuilder(MeterStats base)
Construct a builder initialized with state from specifiedMeterStats
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterStats
build()
A newMeterStats
instance.MeterId
getMeterId()
Return current value associated with the property corresponding toMeterStats.getMeterId()
.MeterStatsKey
key()
Return current value associated with the property corresponding toMeterStats.key()
.MeterStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats>> augmentationType)
Remove an augmentation from this builder's product.MeterStatsBuilder
setMeterId(MeterId value)
Set the property corresponding toMeterStats.getMeterId()
to the specified value.MeterStatsBuilder
withKey(MeterStatsKey key)
-
-
-
Constructor Detail
-
MeterStatsBuilder
public MeterStatsBuilder()
Construct an empty builder.
-
MeterStatsBuilder
public MeterStatsBuilder(MeterStats base)
Construct a builder initialized with state from specifiedMeterStats
.- Parameters:
base
- MeterStats from which the builder should be initialized
-
-
Method Detail
-
key
public MeterStatsKey key()
Return current value associated with the property corresponding toMeterStats.key()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeterStats.getMeterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats>> 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
-
withKey
public MeterStatsBuilder withKey(MeterStatsKey key)
-
setMeterId
public MeterStatsBuilder setMeterId(MeterId value)
Set the property corresponding toMeterStats.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats> 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 MeterStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterStats>> 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 MeterStats build()
A newMeterStats
instance.- Returns:
- A new
MeterStats
instance.
-
-