Class BandStatBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.meter.band.stats.BandStatBuilder
-
@Generated("mdsal-binding-generator") public class BandStatBuilder extends Object
Class that buildsBandStat
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:
BandStat createBandStat(int fooXyzzy, int barBaz) { return new BandStatBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BandStat, 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:
BandStat
- 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 BandStatBuilder()
Construct an empty builder.BandStatBuilder(BandStat base)
Construct a builder initialized with state from specifiedBandStat
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BandStatBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BandStat> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandStat>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BandStat
build()
A newBandStat
instance.BandId
getBandId()
Return current value associated with the property corresponding toBandStat.getBandId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteBandCount()
Return current value associated with the property corresponding toBandStat.getByteBandCount()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketBandCount()
Return current value associated with the property corresponding toBandStat.getPacketBandCount()
.BandStatKey
key()
Return current value associated with the property corresponding toBandStat.key()
.BandStatBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandStat>> augmentationType)
Remove an augmentation from this builder's product.BandStatBuilder
setBandId(BandId value)
Set the property corresponding toBandStat.getBandId()
to the specified value.BandStatBuilder
setByteBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBandStat.getByteBandCount()
to the specified value.BandStatBuilder
setPacketBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBandStat.getPacketBandCount()
to the specified value.BandStatBuilder
withKey(BandStatKey key)
-
-
-
Method Detail
-
key
public BandStatKey key()
Return current value associated with the property corresponding toBandStat.key()
.- Returns:
- current value
-
getBandId
public BandId getBandId()
Return current value associated with the property corresponding toBandStat.getBandId()
.- Returns:
- current value
-
getByteBandCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteBandCount()
Return current value associated with the property corresponding toBandStat.getByteBandCount()
.- Returns:
- current value
-
getPacketBandCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketBandCount()
Return current value associated with the property corresponding toBandStat.getPacketBandCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandStat>> 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 BandStatBuilder withKey(BandStatKey key)
-
setBandId
public BandStatBuilder setBandId(BandId value)
Set the property corresponding toBandStat.getBandId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setByteBandCount
public BandStatBuilder setByteBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBandStat.getByteBandCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketBandCount
public BandStatBuilder setPacketBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBandStat.getPacketBandCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BandStatBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BandStat> 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 BandStatBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandStat>> 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
-
-