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