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