Class BucketBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder
-
@Generated("mdsal-binding-generator") public class BucketBuilder extends Object
Class that buildsBucket
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:
Bucket createBucket(int fooXyzzy, int barBaz) { return new BucketBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Bucket, 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:
Bucket
- 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 BucketBuilder()
Construct an empty builder.BucketBuilder(ActionList arg)
Construct a new builder initialized from specifiedActionList
.BucketBuilder(Bucket base)
Construct a builder initialized with state from specifiedBucket
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BucketBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Bucket> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Bucket
build()
A newBucket
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<ActionKey,Action>
getAction()
Return current value associated with the property corresponding toActionList.getAction()
.BucketId
getBucketId()
Return current value associated with the property corresponding toBucket.getBucketId()
.org.opendaylight.yangtools.yang.common.Uint32
getWatchGroup()
Return current value associated with the property corresponding toBucket.getWatchGroup()
.org.opendaylight.yangtools.yang.common.Uint32
getWatchPort()
Return current value associated with the property corresponding toBucket.getWatchPort()
.org.opendaylight.yangtools.yang.common.Uint16
getWeight()
Return current value associated with the property corresponding toBucket.getWeight()
.BucketKey
key()
Return current value associated with the property corresponding toBucket.key()
.BucketBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> augmentationType)
Remove an augmentation from this builder's product.BucketBuilder
setAction(Map<ActionKey,Action> values)
Set the property corresponding toActionList.getAction()
to the specified value.BucketBuilder
setBucketId(BucketId value)
Set the property corresponding toBucket.getBucketId()
to the specified value.BucketBuilder
setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucket.getWatchGroup()
to the specified value.BucketBuilder
setWatchPort(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucket.getWatchPort()
to the specified value.BucketBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBucket.getWeight()
to the specified value.BucketBuilder
withKey(BucketKey key)
-
-
-
Constructor Detail
-
BucketBuilder
public BucketBuilder()
Construct an empty builder.
-
BucketBuilder
public BucketBuilder(ActionList arg)
Construct a new builder initialized from specifiedActionList
.- Parameters:
arg
- ActionList from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BucketKey key()
Return current value associated with the property corresponding toBucket.key()
.- Returns:
- current value
-
getAction
public Map<ActionKey,Action> getAction()
Return current value associated with the property corresponding toActionList.getAction()
.- Returns:
- current value
-
getBucketId
public BucketId getBucketId()
Return current value associated with the property corresponding toBucket.getBucketId()
.- Returns:
- current value
-
getWatchGroup
public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
Return current value associated with the property corresponding toBucket.getWatchGroup()
.- Returns:
- current value
-
getWatchPort
public org.opendaylight.yangtools.yang.common.Uint32 getWatchPort()
Return current value associated with the property corresponding toBucket.getWatchPort()
.- Returns:
- current value
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
Return current value associated with the property corresponding toBucket.getWeight()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> 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 BucketBuilder withKey(BucketKey key)
-
setAction
public BucketBuilder setAction(Map<ActionKey,Action> values)
Set the property corresponding toActionList.getAction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setBucketId
public BucketBuilder setBucketId(BucketId value)
Set the property corresponding toBucket.getBucketId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWatchGroup
public BucketBuilder setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucket.getWatchGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWatchPort
public BucketBuilder setWatchPort(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucket.getWatchPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWeight
public BucketBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBucket.getWeight()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BucketBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Bucket> 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 BucketBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> 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
-
-