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