Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.aug.nx.action
Class ActionOutputReg2Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.aug.nx.action.ActionOutputReg2Builder
-
@Generated("mdsal-binding-generator") public class ActionOutputReg2Builder extends Object
Class that buildsActionOutputReg2
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:
ActionOutputReg2 createActionOutputReg2(int fooXyzzy, int barBaz) { return new ActionOutputReg2Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ActionOutputReg2, 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:
ActionOutputReg2
- 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 ActionOutputReg2Builder()
Construct an empty builder.ActionOutputReg2Builder(ActionOutputReg2 base)
Construct a builder initialized with state from specifiedActionOutputReg2
.ActionOutputReg2Builder(OfjNxActionOutputReg2Grouping arg)
Construct a new builder initialized from specifiedOfjNxActionOutputReg2Grouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionOutputReg2Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ActionOutputReg2
build()
A newActionOutputReg2
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NxActionOutputReg2
getNxActionOutputReg2()
Return current value associated with the property corresponding toOfjNxActionOutputReg2Grouping.getNxActionOutputReg2()
.ActionOutputReg2Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2>> augmentationType)
Remove an augmentation from this builder's product.ActionOutputReg2Builder
setNxActionOutputReg2(NxActionOutputReg2 value)
Set the property corresponding toOfjNxActionOutputReg2Grouping.getNxActionOutputReg2()
to the specified value.
-
-
-
Constructor Detail
-
ActionOutputReg2Builder
public ActionOutputReg2Builder()
Construct an empty builder.
-
ActionOutputReg2Builder
public ActionOutputReg2Builder(OfjNxActionOutputReg2Grouping arg)
Construct a new builder initialized from specifiedOfjNxActionOutputReg2Grouping
.- Parameters:
arg
- OfjNxActionOutputReg2Grouping from which the builder should be initialized
-
ActionOutputReg2Builder
public ActionOutputReg2Builder(ActionOutputReg2 base)
Construct a builder initialized with state from specifiedActionOutputReg2
.- Parameters:
base
- ActionOutputReg2 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
-
getNxActionOutputReg2
public NxActionOutputReg2 getNxActionOutputReg2()
Return current value associated with the property corresponding toOfjNxActionOutputReg2Grouping.getNxActionOutputReg2()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2>> 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
-
setNxActionOutputReg2
public ActionOutputReg2Builder setNxActionOutputReg2(NxActionOutputReg2 value)
Set the property corresponding toOfjNxActionOutputReg2Grouping.getNxActionOutputReg2()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ActionOutputReg2Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2> 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 ActionOutputReg2Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionOutputReg2>> 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 ActionOutputReg2 build()
A newActionOutputReg2
instance.- Returns:
- A new
ActionOutputReg2
instance.
-
-