Class FlowModCopyValueIntoFieldCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.FlowModCopyValueIntoFieldCaseBuilder
-
@Generated("mdsal-binding-generator") public class FlowModCopyValueIntoFieldCaseBuilder extends Object
Class that buildsFlowModCopyValueIntoFieldCase
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:
FlowModCopyValueIntoFieldCase createFlowModCopyValueIntoFieldCase(int fooXyzzy, int barBaz) { return new FlowModCopyValueIntoFieldCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowModCopyValueIntoFieldCase, 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:
FlowModCopyValueIntoFieldCase
- 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 FlowModCopyValueIntoFieldCaseBuilder()
Construct an empty builder.FlowModCopyValueIntoFieldCaseBuilder(FlowModCopyValueIntoFieldCase base)
Construct a builder initialized with state from specifiedFlowModCopyValueIntoFieldCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowModCopyValueIntoFieldCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowModCopyValueIntoFieldCase
build()
A newFlowModCopyValueIntoFieldCase
instance.FlowModCopyValueIntoField
getFlowModCopyValueIntoField()
Return current value associated with the property corresponding toFlowModCopyValueIntoFieldCase.getFlowModCopyValueIntoField()
.FlowModCopyValueIntoFieldCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> augmentationType)
Remove an augmentation from this builder's product.FlowModCopyValueIntoFieldCaseBuilder
setFlowModCopyValueIntoField(FlowModCopyValueIntoField value)
Set the property corresponding toFlowModCopyValueIntoFieldCase.getFlowModCopyValueIntoField()
to the specified value.
-
-
-
Constructor Detail
-
FlowModCopyValueIntoFieldCaseBuilder
public FlowModCopyValueIntoFieldCaseBuilder()
Construct an empty builder.
-
FlowModCopyValueIntoFieldCaseBuilder
public FlowModCopyValueIntoFieldCaseBuilder(FlowModCopyValueIntoFieldCase base)
Construct a builder initialized with state from specifiedFlowModCopyValueIntoFieldCase
.- Parameters:
base
- FlowModCopyValueIntoFieldCase from which the builder should be initialized
-
-
Method Detail
-
getFlowModCopyValueIntoField
public FlowModCopyValueIntoField getFlowModCopyValueIntoField()
Return current value associated with the property corresponding toFlowModCopyValueIntoFieldCase.getFlowModCopyValueIntoField()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> 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
-
setFlowModCopyValueIntoField
public FlowModCopyValueIntoFieldCaseBuilder setFlowModCopyValueIntoField(FlowModCopyValueIntoField value)
Set the property corresponding toFlowModCopyValueIntoFieldCase.getFlowModCopyValueIntoField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowModCopyValueIntoFieldCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase> 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 FlowModCopyValueIntoFieldCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> 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 @NonNull FlowModCopyValueIntoFieldCase build()
A newFlowModCopyValueIntoFieldCase
instance.- Returns:
- A new
FlowModCopyValueIntoFieldCase
instance.
-
-