Class NxConntrackBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.conntrack.grouping.NxConntrackBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxConntrack>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxConntrack,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxConntrackBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxConntrack>
Class that buildsNxConntrackBuilder
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:
NxConntrackBuilder createTarget(int fooXyzzy, int barBaz) { return new NxConntrackBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxConntrackBuilder, 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 oportunities, 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:
NxConntrackBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxConntrackBuilder()
NxConntrackBuilder(NxConntrack base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxConntrackBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>>
E$$augmentation(Class<E$$> augmentationType)
NxConntrack
build()
org.opendaylight.yangtools.yang.common.Uint16
getConntrackZone()
List<CtActions>
getCtActions()
org.opendaylight.yangtools.yang.common.Uint16
getFlags()
org.opendaylight.yangtools.yang.common.Uint8
getRecircTable()
org.opendaylight.yangtools.yang.common.Uint32
getZoneSrc()
NxConntrackBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>> augmentationType)
NxConntrackBuilder
setConntrackZone(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setConntrackZone(Uint16)} instead.NxConntrackBuilder
setConntrackZone(org.opendaylight.yangtools.yang.common.Uint16 value)
NxConntrackBuilder
setCtActions(List<CtActions> values)
NxConntrackBuilder
setFlags(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setFlags(Uint16)} instead.NxConntrackBuilder
setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
NxConntrackBuilder
setRecircTable(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRecircTable(Uint8)} instead.NxConntrackBuilder
setRecircTable(org.opendaylight.yangtools.yang.common.Uint8 value)
NxConntrackBuilder
setZoneSrc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setZoneSrc(Uint32)} instead.NxConntrackBuilder
setZoneSrc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
NxConntrackBuilder
public NxConntrackBuilder()
-
NxConntrackBuilder
public NxConntrackBuilder(NxConntrack base)
-
-
Method Detail
-
getConntrackZone
public org.opendaylight.yangtools.yang.common.Uint16 getConntrackZone()
-
getFlags
public org.opendaylight.yangtools.yang.common.Uint16 getFlags()
-
getRecircTable
public org.opendaylight.yangtools.yang.common.Uint8 getRecircTable()
-
getZoneSrc
public org.opendaylight.yangtools.yang.common.Uint32 getZoneSrc()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>> E$$ augmentation(Class<E$$> augmentationType)
-
setConntrackZone
public NxConntrackBuilder setConntrackZone(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setConntrackZone
@Deprecated(forRemoval=true) public NxConntrackBuilder setConntrackZone(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setConntrackZone(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCtActions
public NxConntrackBuilder setCtActions(List<CtActions> values)
-
setFlags
public NxConntrackBuilder setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlags
@Deprecated(forRemoval=true) public NxConntrackBuilder setFlags(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setFlags(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setRecircTable
public NxConntrackBuilder setRecircTable(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setRecircTable
@Deprecated(forRemoval=true) public NxConntrackBuilder setRecircTable(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRecircTable(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setZoneSrc
public NxConntrackBuilder setZoneSrc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setZoneSrc
@Deprecated(forRemoval=true) public NxConntrackBuilder setZoneSrc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setZoneSrc(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxConntrackBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack> augmentationValue)
-
removeAugmentation
public NxConntrackBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxConntrack>> augmentationType)
-
build
public NxConntrack build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxConntrack>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxConntrack,IllegalArgumentException>
-
-