Class NxActionCtClearBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.ct.clear.grouping.NxActionCtClearBuilder
-
@Generated("mdsal-binding-generator") public class NxActionCtClearBuilder extends Object
Class that buildsNxActionCtClear
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:
NxActionCtClear createNxActionCtClear(int fooXyzzy, int barBaz) { return new NxActionCtClearBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionCtClear, 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:
NxActionCtClear
- 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 NxActionCtClearBuilder()
Construct an empty builder.NxActionCtClearBuilder(NxActionCtClear base)
Construct a builder initialized with state from specifiedNxActionCtClear
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionCtClearBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxActionCtClear
build()
A newNxActionCtClear
instance.ExperimenterId
getExperimenterId()
Return current value associated with the property corresponding toNxActionCtClear.getExperimenterId()
.NxActionCtClearBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear>> augmentationType)
Remove an augmentation from this builder's product.NxActionCtClearBuilder
setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionCtClear.getExperimenterId()
to the specified value.
-
-
-
Constructor Detail
-
NxActionCtClearBuilder
public NxActionCtClearBuilder()
Construct an empty builder.
-
NxActionCtClearBuilder
public NxActionCtClearBuilder(NxActionCtClear base)
Construct a builder initialized with state from specifiedNxActionCtClear
.- Parameters:
base
- NxActionCtClear from which the builder should be initialized
-
-
Method Detail
-
getExperimenterId
public ExperimenterId getExperimenterId()
Return current value associated with the property corresponding toNxActionCtClear.getExperimenterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear>> 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
-
setExperimenterId
public NxActionCtClearBuilder setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionCtClear.getExperimenterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionCtClearBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear> 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 NxActionCtClearBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtClear>> 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 NxActionCtClear build()
A newNxActionCtClear
instance.- Returns:
- A new
NxActionCtClear
instance.
-
-