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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowModCopyValueIntoField>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCopyValueIntoField,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowModCopyValueIntoFieldBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowModCopyValueIntoField>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowModCopyValueIntoFieldBuilder()
FlowModCopyValueIntoFieldBuilder(FlowModCopyValueIntoField base)
-
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)
FlowModCopyValueIntoField
build()
org.opendaylight.yangtools.yang.common.Uint32
getDstField()
org.opendaylight.yangtools.yang.common.Uint16
getDstOfs()
org.opendaylight.yangtools.yang.common.Uint16
getFlowModNumBits()
org.opendaylight.yangtools.yang.common.Uint16
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)
FlowModCopyValueIntoFieldBuilder
setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCopyValueIntoFieldBuilder
setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCopyValueIntoFieldBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
FlowModCopyValueIntoFieldBuilder
public FlowModCopyValueIntoFieldBuilder()
-
FlowModCopyValueIntoFieldBuilder
public FlowModCopyValueIntoFieldBuilder(FlowModCopyValueIntoField base)
-
-
Method Detail
-
getDstField
public org.opendaylight.yangtools.yang.common.Uint32 getDstField()
-
getDstOfs
public org.opendaylight.yangtools.yang.common.Uint16 getDstOfs()
-
getFlowModNumBits
public org.opendaylight.yangtools.yang.common.Uint16 getFlowModNumBits()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoField>> E$$ augmentation(Class<E$$> augmentationType)
-
setDstField
public FlowModCopyValueIntoFieldBuilder setDstField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDstOfs
public FlowModCopyValueIntoFieldBuilder setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowModNumBits
public FlowModCopyValueIntoFieldBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setValue
public FlowModCopyValueIntoFieldBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
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 FlowModCopyValueIntoField build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowModCopyValueIntoField>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCopyValueIntoField,IllegalArgumentException>
-
-