Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.aug.nx.action
Class ActionRegMoveBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.aug.nx.action.ActionRegMoveBuilder
-
@Generated("mdsal-binding-generator") public class ActionRegMoveBuilder extends Object
Class that buildsActionRegMove
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:
ActionRegMove createActionRegMove(int fooXyzzy, int barBaz) { return new ActionRegMoveBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ActionRegMove, 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:
ActionRegMove
- 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 ActionRegMoveBuilder()
Construct an empty builder.ActionRegMoveBuilder(ActionRegMove base)
Construct a builder initialized with state from specifiedActionRegMove
.ActionRegMoveBuilder(OfjNxActionRegMoveGrouping arg)
Construct a new builder initialized from specifiedOfjNxActionRegMoveGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionRegMoveBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ActionRegMove
build()
A newActionRegMove
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NxActionRegMove
getNxActionRegMove()
Return current value associated with the property corresponding toOfjNxActionRegMoveGrouping.getNxActionRegMove()
.ActionRegMoveBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove>> augmentationType)
Remove an augmentation from this builder's product.ActionRegMoveBuilder
setNxActionRegMove(NxActionRegMove value)
Set the property corresponding toOfjNxActionRegMoveGrouping.getNxActionRegMove()
to the specified value.
-
-
-
Constructor Detail
-
ActionRegMoveBuilder
public ActionRegMoveBuilder()
Construct an empty builder.
-
ActionRegMoveBuilder
public ActionRegMoveBuilder(OfjNxActionRegMoveGrouping arg)
Construct a new builder initialized from specifiedOfjNxActionRegMoveGrouping
.- Parameters:
arg
- OfjNxActionRegMoveGrouping from which the builder should be initialized
-
ActionRegMoveBuilder
public ActionRegMoveBuilder(ActionRegMove base)
Construct a builder initialized with state from specifiedActionRegMove
.- Parameters:
base
- ActionRegMove from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNxActionRegMove
public NxActionRegMove getNxActionRegMove()
Return current value associated with the property corresponding toOfjNxActionRegMoveGrouping.getNxActionRegMove()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove>> 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
-
setNxActionRegMove
public ActionRegMoveBuilder setNxActionRegMove(NxActionRegMove value)
Set the property corresponding toOfjNxActionRegMoveGrouping.getNxActionRegMove()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ActionRegMoveBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove> 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 ActionRegMoveBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionRegMove>> 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 ActionRegMove build()
A newActionRegMove
instance.- Returns:
- A new
ActionRegMove
instance.
-
-