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