Class NxActionLearnBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.learn.grouping.NxActionLearnBuilder
-
@Generated("mdsal-binding-generator") public class NxActionLearnBuilder extends Object
Class that buildsNxActionLearn
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:
NxActionLearn createNxActionLearn(int fooXyzzy, int barBaz) { return new NxActionLearnBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionLearn, 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:
NxActionLearn
- 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 NxActionLearnBuilder()
Construct an empty builder.NxActionLearnBuilder(NxActionLearn base)
Construct a builder initialized with state from specifiedNxActionLearn
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionLearnBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxActionLearn
build()
A newNxActionLearn
instance.org.opendaylight.yangtools.yang.common.Uint64
getCookie()
Return current value associated with the property corresponding toNxActionLearn.getCookie()
.org.opendaylight.yangtools.yang.common.Uint16
getFinHardTimeout()
Return current value associated with the property corresponding toNxActionLearn.getFinHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getFinIdleTimeout()
Return current value associated with the property corresponding toNxActionLearn.getFinIdleTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getFlags()
Return current value associated with the property corresponding toNxActionLearn.getFlags()
.List<FlowMods>
getFlowMods()
Return current value associated with the property corresponding toNxActionLearn.getFlowMods()
.org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
Return current value associated with the property corresponding toNxActionLearn.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Return current value associated with the property corresponding toNxActionLearn.getIdleTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Return current value associated with the property corresponding toNxActionLearn.getPriority()
.org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Return current value associated with the property corresponding toNxActionLearn.getTableId()
.NxActionLearnBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> augmentationType)
Remove an augmentation from this builder's product.NxActionLearnBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionLearn.getCookie()
to the specified value.NxActionLearnBuilder
setFinHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFinHardTimeout()
to the specified value.NxActionLearnBuilder
setFinIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFinIdleTimeout()
to the specified value.NxActionLearnBuilder
setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFlags()
to the specified value.NxActionLearnBuilder
setFlowMods(List<FlowMods> values)
Set the property corresponding toNxActionLearn.getFlowMods()
to the specified value.NxActionLearnBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getHardTimeout()
to the specified value.NxActionLearnBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getIdleTimeout()
to the specified value.NxActionLearnBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getPriority()
to the specified value.NxActionLearnBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNxActionLearn.getTableId()
to the specified value.
-
-
-
Constructor Detail
-
NxActionLearnBuilder
public NxActionLearnBuilder()
Construct an empty builder.
-
NxActionLearnBuilder
public NxActionLearnBuilder(NxActionLearn base)
Construct a builder initialized with state from specifiedNxActionLearn
.- Parameters:
base
- NxActionLearn from which the builder should be initialized
-
-
Method Detail
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
Return current value associated with the property corresponding toNxActionLearn.getCookie()
.- Returns:
- current value
-
getFinHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getFinHardTimeout()
Return current value associated with the property corresponding toNxActionLearn.getFinHardTimeout()
.- Returns:
- current value
-
getFinIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getFinIdleTimeout()
Return current value associated with the property corresponding toNxActionLearn.getFinIdleTimeout()
.- Returns:
- current value
-
getFlags
public org.opendaylight.yangtools.yang.common.Uint16 getFlags()
Return current value associated with the property corresponding toNxActionLearn.getFlags()
.- Returns:
- current value
-
getFlowMods
public List<FlowMods> getFlowMods()
Return current value associated with the property corresponding toNxActionLearn.getFlowMods()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
Return current value associated with the property corresponding toNxActionLearn.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
Return current value associated with the property corresponding toNxActionLearn.getIdleTimeout()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
Return current value associated with the property corresponding toNxActionLearn.getPriority()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
Return current value associated with the property corresponding toNxActionLearn.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> 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
-
setCookie
public NxActionLearnBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxActionLearn.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFinHardTimeout
public NxActionLearnBuilder setFinHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFinHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFinIdleTimeout
public NxActionLearnBuilder setFinIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFinIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public NxActionLearnBuilder setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowMods
public NxActionLearnBuilder setFlowMods(List<FlowMods> values)
Set the property corresponding toNxActionLearn.getFlowMods()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setHardTimeout
public NxActionLearnBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
public NxActionLearnBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public NxActionLearnBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxActionLearn.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public NxActionLearnBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNxActionLearn.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionLearnBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn> 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 NxActionLearnBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> 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 NxActionLearn build()
A newNxActionLearn
instance.- Returns:
- A new
NxActionLearn
instance.
-
-