Class GroupDescBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.multipart.reply.group.desc.GroupDescBuilder
-
@Generated("mdsal-binding-generator") public class GroupDescBuilder extends Object
Class that buildsGroupDesc
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:
GroupDesc createGroupDesc(int fooXyzzy, int barBaz) { return new GroupDescBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupDesc, 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:
GroupDesc
- 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 GroupDescBuilder()
Construct an empty builder.GroupDescBuilder(BucketsGrouping arg)
Construct a new builder initialized from specifiedBucketsGrouping
.GroupDescBuilder(GroupDesc base)
Construct a builder initialized with state from specifiedGroupDesc
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupDescBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GroupDesc
build()
A newGroupDesc
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<BucketsList>
getBucketsList()
Return current value associated with the property corresponding toBucketsGrouping.getBucketsList()
.GroupId
getGroupId()
Return current value associated with the property corresponding toGroupDesc.getGroupId()
.GroupType
getType()
Return current value associated with the property corresponding toGroupDesc.getType()
.GroupDescBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> augmentationType)
Remove an augmentation from this builder's product.GroupDescBuilder
setBucketsList(List<BucketsList> values)
Set the property corresponding toBucketsGrouping.getBucketsList()
to the specified value.GroupDescBuilder
setGroupId(GroupId value)
Set the property corresponding toGroupDesc.getGroupId()
to the specified value.GroupDescBuilder
setType(GroupType value)
Set the property corresponding toGroupDesc.getType()
to the specified value.
-
-
-
Constructor Detail
-
GroupDescBuilder
public GroupDescBuilder()
Construct an empty builder.
-
GroupDescBuilder
public GroupDescBuilder(BucketsGrouping arg)
Construct a new builder initialized from specifiedBucketsGrouping
.- Parameters:
arg
- BucketsGrouping 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
-
getBucketsList
public List<BucketsList> getBucketsList()
Return current value associated with the property corresponding toBucketsGrouping.getBucketsList()
.- Returns:
- current value
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toGroupDesc.getGroupId()
.- Returns:
- current value
-
getType
public GroupType getType()
Return current value associated with the property corresponding toGroupDesc.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> 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
-
setBucketsList
public GroupDescBuilder setBucketsList(List<BucketsList> values)
Set the property corresponding toBucketsGrouping.getBucketsList()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setGroupId
public GroupDescBuilder setGroupId(GroupId value)
Set the property corresponding toGroupDesc.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
public GroupDescBuilder setType(GroupType value)
Set the property corresponding toGroupDesc.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GroupDescBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc> 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 GroupDescBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> 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
-
-