Class BucketsListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsListBuilder
-
@Generated("mdsal-binding-generator") public class BucketsListBuilder extends Object
Class that buildsBucketsList
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:
BucketsList createBucketsList(int fooXyzzy, int barBaz) { return new BucketsListBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BucketsList, 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:
BucketsList
- 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 BucketsListBuilder()
Construct an empty builder.BucketsListBuilder(ActionsGrouping arg)
Construct a new builder initialized from specifiedActionsGrouping
.BucketsListBuilder(BucketGrouping arg)
Construct a new builder initialized from specifiedBucketGrouping
.BucketsListBuilder(BucketsList base)
Construct a builder initialized with state from specifiedBucketsList
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BucketsListBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BucketsList
build()
A newBucketsList
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Action>
getAction()
Return current value associated with the property corresponding toActionsGrouping.getAction()
.org.opendaylight.yangtools.yang.common.Uint32
getWatchGroup()
Return current value associated with the property corresponding toBucketGrouping.getWatchGroup()
.PortNumber
getWatchPort()
Return current value associated with the property corresponding toBucketGrouping.getWatchPort()
.org.opendaylight.yangtools.yang.common.Uint16
getWeight()
Return current value associated with the property corresponding toBucketGrouping.getWeight()
.BucketsListBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList>> augmentationType)
Remove an augmentation from this builder's product.BucketsListBuilder
setAction(List<Action> values)
Set the property corresponding toActionsGrouping.getAction()
to the specified value.BucketsListBuilder
setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucketGrouping.getWatchGroup()
to the specified value.BucketsListBuilder
setWatchPort(PortNumber value)
Set the property corresponding toBucketGrouping.getWatchPort()
to the specified value.BucketsListBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBucketGrouping.getWeight()
to the specified value.
-
-
-
Constructor Detail
-
BucketsListBuilder
public BucketsListBuilder()
Construct an empty builder.
-
BucketsListBuilder
public BucketsListBuilder(BucketGrouping arg)
Construct a new builder initialized from specifiedBucketGrouping
.- Parameters:
arg
- BucketGrouping from which the builder should be initialized
-
BucketsListBuilder
public BucketsListBuilder(ActionsGrouping arg)
Construct a new builder initialized from specifiedActionsGrouping
.- Parameters:
arg
- ActionsGrouping from which the builder should be initialized
-
BucketsListBuilder
public BucketsListBuilder(BucketsList base)
Construct a builder initialized with state from specifiedBucketsList
.- Parameters:
base
- BucketsList 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
-
getAction
public List<Action> getAction()
Return current value associated with the property corresponding toActionsGrouping.getAction()
.- Returns:
- current value
-
getWatchGroup
public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
Return current value associated with the property corresponding toBucketGrouping.getWatchGroup()
.- Returns:
- current value
-
getWatchPort
public PortNumber getWatchPort()
Return current value associated with the property corresponding toBucketGrouping.getWatchPort()
.- Returns:
- current value
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
Return current value associated with the property corresponding toBucketGrouping.getWeight()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList>> 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
-
setAction
public BucketsListBuilder setAction(List<Action> values)
Set the property corresponding toActionsGrouping.getAction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setWatchGroup
public BucketsListBuilder setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBucketGrouping.getWatchGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWatchPort
public BucketsListBuilder setWatchPort(PortNumber value)
Set the property corresponding toBucketGrouping.getWatchPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWeight
public BucketsListBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBucketGrouping.getWeight()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BucketsListBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList> 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 BucketsListBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList>> 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 BucketsList build()
A newBucketsList
instance.- Returns:
- A new
BucketsList
instance.
-
-