Class BucketBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Bucket>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Bucket,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BucketBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Bucket>
Class that buildsBucketBuilder
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:
BucketBuilder createTarget(int fooXyzzy, int barBaz) { return new BucketBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BucketBuilder, 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:
BucketBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BucketBuilder()
BucketBuilder(ActionList arg)
BucketBuilder(Bucket base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
Bucket
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<ActionKey,Action>
getAction()
BucketId
getBucketId()
org.opendaylight.yangtools.yang.common.Uint32
getWatchGroup()
org.opendaylight.yangtools.yang.common.Uint32
getWatchPort()
org.opendaylight.yangtools.yang.common.Uint16
getWeight()
BucketKey
key()
BucketBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> augmentationType)
Remove an augmentation from this builder's product.BucketBuilder
setAction(List<Action> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAction(Map)
instead.BucketBuilder
setAction(Map<ActionKey,Action> values)
BucketBuilder
setBucketId(BucketId value)
BucketBuilder
setWatchGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWatchGroup(Uint32)
instead.BucketBuilder
setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BucketBuilder
setWatchPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWatchPort(Uint32)
instead.BucketBuilder
setWatchPort(org.opendaylight.yangtools.yang.common.Uint32 value)
BucketBuilder
setWeight(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWeight(Uint16)
instead.BucketBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
BucketBuilder
withKey(BucketKey key)
-
-
-
Constructor Detail
-
BucketBuilder
public BucketBuilder()
-
BucketBuilder
public BucketBuilder(ActionList arg)
-
BucketBuilder
public BucketBuilder(Bucket 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.action.types.rev131112.ActionList
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BucketKey key()
-
getBucketId
public BucketId getBucketId()
-
getWatchGroup
public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
-
getWatchPort
public org.opendaylight.yangtools.yang.common.Uint32 getWatchPort()
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BucketBuilder withKey(BucketKey key)
-
setAction
public BucketBuilder setAction(Map<ActionKey,Action> values)
-
setAction
@Deprecated(forRemoval=true) public BucketBuilder setAction(List<Action> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAction(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setBucketId
public BucketBuilder setBucketId(BucketId value)
-
setWatchGroup
public BucketBuilder setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setWatchGroup
@Deprecated(forRemoval=true) public BucketBuilder 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 BucketBuilder setWatchPort(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setWatchPort
@Deprecated(forRemoval=true) public BucketBuilder setWatchPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetWatchPort(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setWeight
public BucketBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setWeight
@Deprecated(forRemoval=true) public BucketBuilder 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 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
-
build
public Bucket build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Bucket>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Bucket,IllegalArgumentException>
-
-