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