Class BandStatBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.meter.band.stats.BandStatBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BandStat>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BandStat,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BandStatBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BandStat>
Class that buildsBandStatBuilder
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:
BandStatBuilder createTarget(int fooXyzzy, int barBaz) { return new BandStatBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BandStatBuilder, 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:
BandStatBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BandStatBuilder()
BandStatBuilder(BandStat base)
-
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)
BandStat
build()
BandId
getBandId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteBandCount()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketBandCount()
BandStatKey
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)
BandStatBuilder
setByteBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
BandStatBuilder
setPacketBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
BandStatBuilder
withKey(BandStatKey key)
-
-
-
Constructor Detail
-
BandStatBuilder
public BandStatBuilder()
-
BandStatBuilder
public BandStatBuilder(BandStat base)
-
-
Method Detail
-
key
public BandStatKey key()
-
getBandId
public BandId getBandId()
-
getByteBandCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteBandCount()
-
getPacketBandCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketBandCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandStat>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BandStatBuilder withKey(BandStatKey key)
-
setBandId
public BandStatBuilder setBandId(BandId value)
-
setByteBandCount
public BandStatBuilder setByteBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setPacketBandCount
public BandStatBuilder setPacketBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
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
-
build
public BandStat build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BandStat>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BandStat,IllegalArgumentException>
-
-