Class NxActionConntrackBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.conntrack.grouping.NxActionConntrackBuilder
Class that builds
NxActionConntrack
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:
NxActionConntrack createNxActionConntrack(int fooXyzzy, int barBaz) {
return new NxActionConntrackBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NxActionConntrack, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedNxActionConntrack
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull NxActionConntrack
build()
A newNxActionConntrack
instance.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toNxActionConntrack.getConntrackZone()
.Return current value associated with the property corresponding toNxActionConntrack.getCtActions()
.Return current value associated with the property corresponding toNxActionConntrack.getExperimenterId()
.org.opendaylight.yangtools.yang.common.Uint16
getFlags()
Return current value associated with the property corresponding toNxActionConntrack.getFlags()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toNxActionConntrack.getRecircTable()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toNxActionConntrack.getZoneSrc()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack>> augmentationType) Remove an augmentation from this builder's product.setConntrackZone
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toNxActionConntrack.getConntrackZone()
to the specified value.setCtActions
(List<CtActions> values) Set the property corresponding toNxActionConntrack.getCtActions()
to the specified value.setExperimenterId
(ExperimenterId value) Set the property corresponding toNxActionConntrack.getExperimenterId()
to the specified value.setFlags
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toNxActionConntrack.getFlags()
to the specified value.setRecircTable
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toNxActionConntrack.getRecircTable()
to the specified value.setZoneSrc
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toNxActionConntrack.getZoneSrc()
to the specified value.
-
Constructor Details
-
NxActionConntrackBuilder
public NxActionConntrackBuilder()Construct an empty builder. -
NxActionConntrackBuilder
Construct a builder initialized with state from specifiedNxActionConntrack
.- Parameters:
base
- NxActionConntrack from which the builder should be initialized
-
-
Method Details
-
getConntrackZone
public org.opendaylight.yangtools.yang.common.Uint16 getConntrackZone()Return current value associated with the property corresponding toNxActionConntrack.getConntrackZone()
.- Returns:
- current value
-
getCtActions
Return current value associated with the property corresponding toNxActionConntrack.getCtActions()
.- Returns:
- current value
-
getExperimenterId
Return current value associated with the property corresponding toNxActionConntrack.getExperimenterId()
.- Returns:
- current value
-
getFlags
public org.opendaylight.yangtools.yang.common.Uint16 getFlags()Return current value associated with the property corresponding toNxActionConntrack.getFlags()
.- Returns:
- current value
-
getRecircTable
public org.opendaylight.yangtools.yang.common.Uint8 getRecircTable()Return current value associated with the property corresponding toNxActionConntrack.getRecircTable()
.- Returns:
- current value
-
getZoneSrc
public org.opendaylight.yangtools.yang.common.Uint32 getZoneSrc()Return current value associated with the property corresponding toNxActionConntrack.getZoneSrc()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack>> 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
-
setConntrackZone
public NxActionConntrackBuilder setConntrackZone(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toNxActionConntrack.getConntrackZone()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCtActions
Set the property corresponding toNxActionConntrack.getCtActions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setExperimenterId
Set the property corresponding toNxActionConntrack.getExperimenterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
Set the property corresponding toNxActionConntrack.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRecircTable
Set the property corresponding toNxActionConntrack.getRecircTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setZoneSrc
Set the property corresponding toNxActionConntrack.getZoneSrc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionConntrackBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack> 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 NxActionConntrackBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionConntrack>> 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
A newNxActionConntrack
instance.- Returns:
- A new
NxActionConntrack
instance.
-