Class NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nodes.node.table.flow.instructions.instruction.instruction.write.actions._case.write.actions.action.action.NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
@Generated("mdsal-binding-generator")
public class NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
extends Object
Class that builds
NxActionEncapNodesNodeTableFlowWriteActionsCase
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:
NxActionEncapNodesNodeTableFlowWriteActionsCase createNxActionEncapNodesNodeTableFlowWriteActionsCase(int fooXyzzy, int barBaz) {
return new NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NxActionEncapNodesNodeTableFlowWriteActionsCase, 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
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
(NxActionEncapNodesNodeTableFlowWriteActionsCase base) Construct a builder initialized with state from specifiedNxActionEncapNodesNodeTableFlowWriteActionsCase
.Construct a new builder initialized from specifiedNxActionEncapGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.build()
A newNxActionEncapNodesNodeTableFlowWriteActionsCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toNxActionEncapGrouping.getNxEncap()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase>> augmentationType) Remove an augmentation from this builder's product.setNxEncap
(NxEncap value) Set the property corresponding toNxActionEncapGrouping.getNxEncap()
to the specified value.
-
Constructor Details
-
NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
public NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder()Construct an empty builder. -
NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
Construct a new builder initialized from specifiedNxActionEncapGrouping
.- Parameters:
arg
- NxActionEncapGrouping from which the builder should be initialized
-
NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder
public NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder(NxActionEncapNodesNodeTableFlowWriteActionsCase base) Construct a builder initialized with state from specifiedNxActionEncapNodesNodeTableFlowWriteActionsCase
.- Parameters:
base
- NxActionEncapNodesNodeTableFlowWriteActionsCase from which the builder should be initialized
-
-
Method Details
-
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
-
getNxEncap
Return current value associated with the property corresponding toNxActionEncapGrouping.getNxEncap()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase>> 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
-
setNxEncap
Set the property corresponding toNxActionEncapGrouping.getNxEncap()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase> 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 NxActionEncapNodesNodeTableFlowWriteActionsCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapNodesNodeTableFlowWriteActionsCase>> 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
A newNxActionEncapNodesNodeTableFlowWriteActionsCase
instance.- Returns:
- A new
NxActionEncapNodesNodeTableFlowWriteActionsCase
instance.
-