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
-
@Generated("mdsal-binding-generator") public class BucketCounterBuilder extends Object
Class that buildsBucketCounter
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:
BucketCounter createBucketCounter(int fooXyzzy, int barBaz) { return new BucketCounterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BucketCounter, 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:
BucketCounter
- 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 BucketCounterBuilder()
Construct an empty builder.BucketCounterBuilder(BucketCounter base)
Construct a builder initialized with state from specifiedBucketCounter
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull BucketCounter
build()
A newBucketCounter
instance.BucketId
getBucketId()
Return current value associated with the property corresponding toBucketCounter.getBucketId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteCount()
Return current value associated with the property corresponding toBucketCounter.getByteCount()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
Return current value associated with the property corresponding toBucketCounter.getPacketCount()
.BucketCounterKey
key()
Return current value associated with the property corresponding toBucketCounter.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)
Set the property corresponding toBucketCounter.getBucketId()
to the specified value.BucketCounterBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBucketCounter.getByteCount()
to the specified value.BucketCounterBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBucketCounter.getPacketCount()
to the specified value.BucketCounterBuilder
withKey(BucketCounterKey key)
-
-
-
Constructor Detail
-
BucketCounterBuilder
public BucketCounterBuilder()
Construct an empty builder.
-
BucketCounterBuilder
public BucketCounterBuilder(BucketCounter base)
Construct a builder initialized with state from specifiedBucketCounter
.- Parameters:
base
- BucketCounter from which the builder should be initialized
-
-
Method Detail
-
key
public BucketCounterKey key()
Return current value associated with the property corresponding toBucketCounter.key()
.- Returns:
- current value
-
getBucketId
public BucketId getBucketId()
Return current value associated with the property corresponding toBucketCounter.getBucketId()
.- Returns:
- current value
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
Return current value associated with the property corresponding toBucketCounter.getByteCount()
.- Returns:
- current value
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
Return current value associated with the property corresponding toBucketCounter.getPacketCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>> 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 BucketCounterBuilder withKey(BucketCounterKey key)
-
setBucketId
public BucketCounterBuilder setBucketId(BucketId value)
Set the property corresponding toBucketCounter.getBucketId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setByteCount
public BucketCounterBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBucketCounter.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public BucketCounterBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toBucketCounter.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull BucketCounter build()
A newBucketCounter
instance.- Returns:
- A new
BucketCounter
instance.
-
-