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