Class FlowModAddMatchFromValueBuilder
- 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.value._case.FlowModAddMatchFromValueBuilder
-
@Generated("mdsal-binding-generator") public class FlowModAddMatchFromValueBuilder extends Object
Class that buildsFlowModAddMatchFromValue
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:
FlowModAddMatchFromValue createFlowModAddMatchFromValue(int fooXyzzy, int barBaz) { return new FlowModAddMatchFromValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowModAddMatchFromValue, 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:
FlowModAddMatchFromValue
- 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 FlowModAddMatchFromValueBuilder()
Construct an empty builder.FlowModAddMatchFromValueBuilder(FlowModAddMatchFromValue base)
Construct a builder initialized with state from specifiedFlowModAddMatchFromValue
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowModAddMatchFromValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowModAddMatchFromValue
build()
A newFlowModAddMatchFromValue
instance.org.opendaylight.yangtools.yang.common.Uint16
getFlowModNumBits()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getFlowModNumBits()
.org.opendaylight.yangtools.yang.common.Uint32
getSrcField()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getSrcField()
.org.opendaylight.yangtools.yang.common.Uint16
getSrcOfs()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getSrcOfs()
.org.opendaylight.yangtools.yang.common.Uint16
getValue()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getValue()
.FlowModAddMatchFromValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue>> augmentationType)
Remove an augmentation from this builder's product.FlowModAddMatchFromValueBuilder
setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getFlowModNumBits()
to the specified value.FlowModAddMatchFromValueBuilder
setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModAddMatchFromValue.getSrcField()
to the specified value.FlowModAddMatchFromValueBuilder
setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getSrcOfs()
to the specified value.FlowModAddMatchFromValueBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getValue()
to the specified value.
-
-
-
Constructor Detail
-
FlowModAddMatchFromValueBuilder
public FlowModAddMatchFromValueBuilder()
Construct an empty builder.
-
FlowModAddMatchFromValueBuilder
public FlowModAddMatchFromValueBuilder(FlowModAddMatchFromValue base)
Construct a builder initialized with state from specifiedFlowModAddMatchFromValue
.- Parameters:
base
- FlowModAddMatchFromValue from which the builder should be initialized
-
-
Method Detail
-
getFlowModNumBits
public org.opendaylight.yangtools.yang.common.Uint16 getFlowModNumBits()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getFlowModNumBits()
.- Returns:
- current value
-
getSrcField
public org.opendaylight.yangtools.yang.common.Uint32 getSrcField()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getSrcField()
.- Returns:
- current value
-
getSrcOfs
public org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getSrcOfs()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
Return current value associated with the property corresponding toFlowModAddMatchFromValue.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue>> 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
-
setFlowModNumBits
public FlowModAddMatchFromValueBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getFlowModNumBits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcField
public FlowModAddMatchFromValueBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModAddMatchFromValue.getSrcField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcOfs
public FlowModAddMatchFromValueBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getSrcOfs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public FlowModAddMatchFromValueBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowModAddMatchFromValue.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowModAddMatchFromValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue> 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 FlowModAddMatchFromValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromValue>> 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 FlowModAddMatchFromValue build()
A newFlowModAddMatchFromValue
instance.- Returns:
- A new
FlowModAddMatchFromValue
instance.
-
-