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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowModCopyFieldIntoField>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCopyFieldIntoField,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowModCopyFieldIntoFieldBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowModCopyFieldIntoField>
Class that buildsFlowModCopyFieldIntoField
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:
FlowModCopyFieldIntoField
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowModCopyFieldIntoFieldBuilder()
FlowModCopyFieldIntoFieldBuilder(FlowModCopyFieldIntoField base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowModCopyFieldIntoFieldBuilder
addAugmentation(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)
FlowModCopyFieldIntoField
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.Uint32
getSrcField()
org.opendaylight.yangtools.yang.common.Uint16
getSrcOfs()
FlowModCopyFieldIntoFieldBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>> augmentationType)
Remove an augmentation from this builder's product.FlowModCopyFieldIntoFieldBuilder
setDstField(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModCopyFieldIntoFieldBuilder
setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCopyFieldIntoFieldBuilder
setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCopyFieldIntoFieldBuilder
setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModCopyFieldIntoFieldBuilder
setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
FlowModCopyFieldIntoFieldBuilder
public FlowModCopyFieldIntoFieldBuilder()
-
FlowModCopyFieldIntoFieldBuilder
public FlowModCopyFieldIntoFieldBuilder(FlowModCopyFieldIntoField 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()
-
getSrcField
public org.opendaylight.yangtools.yang.common.Uint32 getSrcField()
-
getSrcOfs
public org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoField>> E$$ augmentation(Class<E$$> augmentationType)
-
setDstField
public FlowModCopyFieldIntoFieldBuilder setDstField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDstOfs
public FlowModCopyFieldIntoFieldBuilder setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowModNumBits
public FlowModCopyFieldIntoFieldBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSrcField
public FlowModCopyFieldIntoFieldBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSrcOfs
public FlowModCopyFieldIntoFieldBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
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
public FlowModCopyFieldIntoField build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowModCopyFieldIntoField>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCopyFieldIntoField,IllegalArgumentException>
-
-