Class NxActionRegMoveBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.reg.move.grouping.NxActionRegMoveBuilder
-
@Generated("mdsal-binding-generator") public class NxActionRegMoveBuilder extends Object
Class that buildsNxActionRegMove
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:
NxActionRegMove createNxActionRegMove(int fooXyzzy, int barBaz) { return new NxActionRegMoveBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionRegMove, 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:
NxActionRegMove
- 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 NxActionRegMoveBuilder()
Construct an empty builder.NxActionRegMoveBuilder(NxActionRegMove base)
Construct a builder initialized with state from specifiedNxActionRegMove
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionRegMoveBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxActionRegMove
build()
A newNxActionRegMove
instance.org.opendaylight.yangtools.yang.common.Uint64
getDst()
Return current value associated with the property corresponding toNxActionRegMove.getDst()
.org.opendaylight.yangtools.yang.common.Uint16
getDstOfs()
Return current value associated with the property corresponding toNxActionRegMove.getDstOfs()
.ExperimenterId
getExperimenterId()
Return current value associated with the property corresponding toNxActionRegMove.getExperimenterId()
.org.opendaylight.yangtools.yang.common.Uint16
getNBits()
Return current value associated with the property corresponding toNxActionRegMove.getNBits()
.org.opendaylight.yangtools.yang.common.Uint64
getSrc()
Return current value associated with the property corresponding toNxActionRegMove.getSrc()
.org.opendaylight.yangtools.yang.common.Uint16
getSrcOfs()
Return current value associated with the property corresponding toNxActionRegMove.getSrcOfs()
.NxActionRegMoveBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove>> augmentationType)
Remove an augmentation from this builder's product.NxActionRegMoveBuilder
setDst(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionRegMove.getDst()
to the specified value.NxActionRegMoveBuilder
setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getDstOfs()
to the specified value.NxActionRegMoveBuilder
setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionRegMove.getExperimenterId()
to the specified value.NxActionRegMoveBuilder
setNBits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getNBits()
to the specified value.NxActionRegMoveBuilder
setSrc(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionRegMove.getSrc()
to the specified value.NxActionRegMoveBuilder
setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getSrcOfs()
to the specified value.
-
-
-
Constructor Detail
-
NxActionRegMoveBuilder
public NxActionRegMoveBuilder()
Construct an empty builder.
-
NxActionRegMoveBuilder
public NxActionRegMoveBuilder(NxActionRegMove base)
Construct a builder initialized with state from specifiedNxActionRegMove
.- Parameters:
base
- NxActionRegMove from which the builder should be initialized
-
-
Method Detail
-
getDst
public org.opendaylight.yangtools.yang.common.Uint64 getDst()
Return current value associated with the property corresponding toNxActionRegMove.getDst()
.- Returns:
- current value
-
getDstOfs
public org.opendaylight.yangtools.yang.common.Uint16 getDstOfs()
Return current value associated with the property corresponding toNxActionRegMove.getDstOfs()
.- Returns:
- current value
-
getExperimenterId
public ExperimenterId getExperimenterId()
Return current value associated with the property corresponding toNxActionRegMove.getExperimenterId()
.- Returns:
- current value
-
getNBits
public org.opendaylight.yangtools.yang.common.Uint16 getNBits()
Return current value associated with the property corresponding toNxActionRegMove.getNBits()
.- Returns:
- current value
-
getSrc
public org.opendaylight.yangtools.yang.common.Uint64 getSrc()
Return current value associated with the property corresponding toNxActionRegMove.getSrc()
.- Returns:
- current value
-
getSrcOfs
public org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()
Return current value associated with the property corresponding toNxActionRegMove.getSrcOfs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove>> 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
-
setDst
public NxActionRegMoveBuilder setDst(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionRegMove.getDst()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDstOfs
public NxActionRegMoveBuilder setDstOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getDstOfs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExperimenterId
public NxActionRegMoveBuilder setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionRegMove.getExperimenterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNBits
public NxActionRegMoveBuilder setNBits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getNBits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrc
public NxActionRegMoveBuilder setSrc(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionRegMove.getSrc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcOfs
public NxActionRegMoveBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionRegMove.getSrcOfs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionRegMoveBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove> 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 NxActionRegMoveBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegMove>> 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 NxActionRegMove build()
A newNxActionRegMove
instance.- Returns:
- A new
NxActionRegMove
instance.
-
-