Package org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.buckets
Class BucketCounterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.buckets.BucketCounterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BucketCounter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BucketCounter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BucketCounterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BucketCounter>
Class that buildsBucketCounterBuilder
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:
BucketCounterBuilder createTarget(int fooXyzzy, int barBaz) { return new BucketCounterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BucketCounterBuilder, 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:
BucketCounterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BucketCounterBuilder()
BucketCounterBuilder(BucketCounter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BucketCounterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>>
E$$augmentation(Class<E$$> augmentationType)
BucketCounter
build()
BucketId
getBucketId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteCount()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
BucketCounterKey
key()
BucketCounterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>> augmentationType)
Remove an augmentation from this builder's product.BucketCounterBuilder
setBucketId(BucketId value)
BucketCounterBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
BucketCounterBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
BucketCounterBuilder
withKey(BucketCounterKey key)
-
-
-
Constructor Detail
-
BucketCounterBuilder
public BucketCounterBuilder()
-
BucketCounterBuilder
public BucketCounterBuilder(BucketCounter base)
-
-
Method Detail
-
key
public BucketCounterKey key()
-
getBucketId
public BucketId getBucketId()
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BucketCounterBuilder withKey(BucketCounterKey key)
-
setBucketId
public BucketCounterBuilder setBucketId(BucketId value)
-
setByteCount
public BucketCounterBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setPacketCount
public BucketCounterBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
addAugmentation
public BucketCounterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter> 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 BucketCounterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>> 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 BucketCounter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BucketCounter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BucketCounter,IllegalArgumentException>
-
-