Class BucketsListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsListBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BucketsList>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BucketsList,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BucketsListBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BucketsList>
Class that buildsBucketsListBuilder
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:
BucketsListBuilder createTarget(int fooXyzzy, int barBaz) { return new BucketsListBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BucketsListBuilder, 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:
BucketsListBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BucketsListBuilder()
BucketsListBuilder(ActionsGrouping arg)
BucketsListBuilder(BucketGrouping arg)
BucketsListBuilder(BucketsList base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
BucketsList
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Action>
getAction()
org.opendaylight.yangtools.yang.common.Uint32
getWatchGroup()
PortNumber
getWatchPort()
org.opendaylight.yangtools.yang.common.Uint16
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)
BucketsListBuilder
setWatchGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWatchGroup(Uint32)
instead.BucketsListBuilder
setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BucketsListBuilder
setWatchPort(PortNumber value)
BucketsListBuilder
setWeight(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWeight(Uint16)
instead.BucketsListBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
BucketsListBuilder
public BucketsListBuilder()
-
BucketsListBuilder
public BucketsListBuilder(BucketGrouping arg)
-
BucketsListBuilder
public BucketsListBuilder(ActionsGrouping arg)
-
BucketsListBuilder
public BucketsListBuilder(BucketsList base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BucketGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getWatchGroup
public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
-
getWatchPort
public PortNumber getWatchPort()
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketsList>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public BucketsListBuilder setAction(List<Action> values)
-
setWatchGroup
public BucketsListBuilder setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setWatchGroup
@Deprecated(forRemoval=true) public BucketsListBuilder setWatchGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWatchGroup(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setWatchPort
public BucketsListBuilder setWatchPort(PortNumber value)
-
setWeight
public BucketsListBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setWeight
@Deprecated(forRemoval=true) public BucketsListBuilder setWeight(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWeight(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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 BucketsList build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BucketsList>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BucketsList,IllegalArgumentException>
-
-