Class FlowModCopyFieldIntoFieldBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.copy.field.into.field._case.FlowModCopyFieldIntoFieldBuilder
Class that builds
FlowModCopyFieldIntoField
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:
FlowModCopyFieldIntoField createFlowModCopyFieldIntoField(int fooXyzzy, int barBaz) {
return new FlowModCopyFieldIntoFieldBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of FlowModCopyFieldIntoField, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedFlowModCopyFieldIntoField
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull FlowModCopyFieldIntoField
build()
A newFlowModCopyFieldIntoField
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getDstField()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getDstOfs()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getFlowModNumBits()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getSrcField()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getSrcOfs()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>> augmentationType) Remove an augmentation from this builder's product.setDstField
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModCopyFieldIntoField.getDstField()
to the specified value.setDstOfs
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getDstOfs()
to the specified value.setFlowModNumBits
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getFlowModNumBits()
to the specified value.setSrcField
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModCopyFieldIntoField.getSrcField()
to the specified value.setSrcOfs
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getSrcOfs()
to the specified value.
-
Constructor Details
-
FlowModCopyFieldIntoFieldBuilder
public FlowModCopyFieldIntoFieldBuilder()Construct an empty builder. -
FlowModCopyFieldIntoFieldBuilder
Construct a builder initialized with state from specifiedFlowModCopyFieldIntoField
.- Parameters:
base
- FlowModCopyFieldIntoField from which the builder should be initialized
-
-
Method Details
-
getDstField
public org.opendaylight.yangtools.yang.common.Uint32 getDstField()Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getDstField()
.- Returns:
- current value
-
getDstOfs
public org.opendaylight.yangtools.yang.common.Uint16 getDstOfs()Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getDstOfs()
.- Returns:
- current value
-
getFlowModNumBits
public org.opendaylight.yangtools.yang.common.Uint16 getFlowModNumBits()Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getFlowModNumBits()
.- Returns:
- current value
-
getSrcField
public org.opendaylight.yangtools.yang.common.Uint32 getSrcField()Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getSrcField()
.- Returns:
- current value
-
getSrcOfs
public org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()Return current value associated with the property corresponding toFlowModCopyFieldIntoField.getSrcOfs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>> 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 FlowModCopyFieldIntoFieldBuilder setDstField(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModCopyFieldIntoField.getDstField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDstOfs
public FlowModCopyFieldIntoFieldBuilder setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getDstOfs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowModNumBits
public FlowModCopyFieldIntoFieldBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getFlowModNumBits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcField
public FlowModCopyFieldIntoFieldBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModCopyFieldIntoField.getSrcField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcOfs
public FlowModCopyFieldIntoFieldBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowModCopyFieldIntoField.getSrcOfs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowModCopyFieldIntoFieldBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField> 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 FlowModCopyFieldIntoFieldBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>> 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 newFlowModCopyFieldIntoField
instance.- Returns:
- A new
FlowModCopyFieldIntoField
instance.
-