Class NxActionDecapRpcAddFlowWriteActionsCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.add.flow.input.instructions.instruction.instruction.write.actions._case.write.actions.action.action.NxActionDecapRpcAddFlowWriteActionsCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionDecapRpcAddFlowWriteActionsCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionDecapRpcAddFlowWriteActionsCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxActionDecapRpcAddFlowWriteActionsCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionDecapRpcAddFlowWriteActionsCase>
Class that buildsNxActionDecapRpcAddFlowWriteActionsCaseBuilder
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:
NxActionDecapRpcAddFlowWriteActionsCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new NxActionDecapRpcAddFlowWriteActionsCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionDecapRpcAddFlowWriteActionsCaseBuilder, 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:
NxActionDecapRpcAddFlowWriteActionsCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionDecapRpcAddFlowWriteActionsCaseBuilder()
NxActionDecapRpcAddFlowWriteActionsCaseBuilder(NxActionDecapRpcAddFlowWriteActionsCase base)
NxActionDecapRpcAddFlowWriteActionsCaseBuilder(NxActionDecapGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxActionDecapRpcAddFlowWriteActionsCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.NxActionDecapRpcAddFlowWriteActionsCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>>
E$$augmentation(Class<E$$> augmentationType)
NxActionDecapRpcAddFlowWriteActionsCase
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NxDecap
getNxDecap()
NxActionDecapRpcAddFlowWriteActionsCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>> augmentationType)
Remove an augmentation from this builder's product.NxActionDecapRpcAddFlowWriteActionsCaseBuilder
setNxDecap(NxDecap value)
-
-
-
Constructor Detail
-
NxActionDecapRpcAddFlowWriteActionsCaseBuilder
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder()
-
NxActionDecapRpcAddFlowWriteActionsCaseBuilder
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder(NxActionDecapGrouping arg)
-
NxActionDecapRpcAddFlowWriteActionsCaseBuilder
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder(NxActionDecapRpcAddFlowWriteActionsCase 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.openflowplugin.extension.nicira.action.rev140714.NxActionDecapGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNxDecap
public NxDecap getNxDecap()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setNxDecap
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder setNxDecap(NxDecap value)
-
addAugmentation
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public NxActionDecapRpcAddFlowWriteActionsCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public NxActionDecapRpcAddFlowWriteActionsCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionDecapRpcAddFlowWriteActionsCase>> 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 NxActionDecapRpcAddFlowWriteActionsCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionDecapRpcAddFlowWriteActionsCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionDecapRpcAddFlowWriteActionsCase,IllegalArgumentException>
-
-