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