Class GroupCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.GroupCaseBuilder
-
@Generated("mdsal-binding-generator") public class GroupCaseBuilder extends Object
Class that buildsGroupCase
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:
GroupCase createGroupCase(int fooXyzzy, int barBaz) { return new GroupCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupCase, 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:
GroupCase
- 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 GroupCaseBuilder()
Construct an empty builder.GroupCaseBuilder(GroupCase base)
Construct a builder initialized with state from specifiedGroupCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GroupCase
build()
A newGroupCase
instance.GroupAction
getGroupAction()
Return current value associated with the property corresponding toGroupCase.getGroupAction()
.GroupCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase>> augmentationType)
Remove an augmentation from this builder's product.GroupCaseBuilder
setGroupAction(GroupAction value)
Set the property corresponding toGroupCase.getGroupAction()
to the specified value.
-
-
-
Method Detail
-
getGroupAction
public GroupAction getGroupAction()
Return current value associated with the property corresponding toGroupCase.getGroupAction()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase>> 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
-
setGroupAction
public GroupCaseBuilder setGroupAction(GroupAction value)
Set the property corresponding toGroupCase.getGroupAction()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GroupCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase> 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 GroupCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupCase>> 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
-
-