Class FlowModAddMatchFromFieldBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.add.match.from.field._case.FlowModAddMatchFromFieldBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowModAddMatchFromField>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModAddMatchFromField,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlowModAddMatchFromFieldBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowModAddMatchFromField>
Class that buildsFlowModAddMatchFromFieldBuilder
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:
FlowModAddMatchFromFieldBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowModAddMatchFromFieldBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowModAddMatchFromFieldBuilder, 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 oportunities, 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:
FlowModAddMatchFromFieldBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowModAddMatchFromFieldBuilder()
FlowModAddMatchFromFieldBuilder(FlowModAddMatchFromField base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowModAddMatchFromFieldBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.FlowModAddMatchFromFieldBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>>
E$$augmentation(Class<E$$> augmentationType)
FlowModAddMatchFromField
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()
FlowModAddMatchFromFieldBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> augmentationType)
Remove an augmentation from this builder's product.FlowModAddMatchFromFieldBuilder
setDstField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDstField(Uint32)
instead.FlowModAddMatchFromFieldBuilder
setDstField(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModAddMatchFromFieldBuilder
setDstOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDstOfs(Uint16)
instead.FlowModAddMatchFromFieldBuilder
setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModAddMatchFromFieldBuilder
setFlowModNumBits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlowModNumBits(Uint16)
instead.FlowModAddMatchFromFieldBuilder
setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModAddMatchFromFieldBuilder
setSrcField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcField(Uint32)
instead.FlowModAddMatchFromFieldBuilder
setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModAddMatchFromFieldBuilder
setSrcOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcOfs(Uint16)
instead.FlowModAddMatchFromFieldBuilder
setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
FlowModAddMatchFromFieldBuilder
public FlowModAddMatchFromFieldBuilder()
-
FlowModAddMatchFromFieldBuilder
public FlowModAddMatchFromFieldBuilder(FlowModAddMatchFromField 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<FlowModAddMatchFromField>> E$$ augmentation(Class<E$$> augmentationType)
-
setDstField
public FlowModAddMatchFromFieldBuilder setDstField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDstField
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder setDstField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDstField(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDstOfs
public FlowModAddMatchFromFieldBuilder setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDstOfs
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder setDstOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDstOfs(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFlowModNumBits
public FlowModAddMatchFromFieldBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowModNumBits
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder setFlowModNumBits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlowModNumBits(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrcField
public FlowModAddMatchFromFieldBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSrcField
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder setSrcField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcField(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrcOfs
public FlowModAddMatchFromFieldBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSrcOfs
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder setSrcOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcOfs(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public FlowModAddMatchFromFieldBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public FlowModAddMatchFromFieldBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public FlowModAddMatchFromFieldBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> 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 FlowModAddMatchFromField build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowModAddMatchFromField>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowModAddMatchFromField,IllegalArgumentException>
-
-