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