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