Class NxActionMultipathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.multipath.grouping.NxActionMultipathBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionMultipath>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionMultipath,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxActionMultipathBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionMultipath>
Class that buildsNxActionMultipathBuilder
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:
NxActionMultipathBuilder createTarget(int fooXyzzy, int barBaz) { return new NxActionMultipathBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionMultipathBuilder, 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:
NxActionMultipathBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionMultipathBuilder()
NxActionMultipathBuilder(NxActionMultipath base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxActionMultipathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath>>
E$$augmentation(Class<E$$> augmentationType)
NxActionMultipath
build()
OfjNxMpAlgorithm
getAlgorithm()
org.opendaylight.yangtools.yang.common.Uint32
getArg()
org.opendaylight.yangtools.yang.common.Uint16
getBasis()
org.opendaylight.yangtools.yang.common.Uint32
getDst()
ExperimenterId
getExperimenterId()
OfjNxHashFields
getFields()
org.opendaylight.yangtools.yang.common.Uint16
getMaxLink()
org.opendaylight.yangtools.yang.common.Uint16
getOfsNbits()
NxActionMultipathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath>> augmentationType)
Remove an augmentation from this builder's product.NxActionMultipathBuilder
setAlgorithm(OfjNxMpAlgorithm value)
NxActionMultipathBuilder
setArg(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetArg(Uint32)
instead.NxActionMultipathBuilder
setArg(org.opendaylight.yangtools.yang.common.Uint32 value)
NxActionMultipathBuilder
setBasis(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBasis(Uint16)
instead.NxActionMultipathBuilder
setBasis(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionMultipathBuilder
setDst(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDst(Uint32)
instead.NxActionMultipathBuilder
setDst(org.opendaylight.yangtools.yang.common.Uint32 value)
NxActionMultipathBuilder
setExperimenterId(ExperimenterId value)
NxActionMultipathBuilder
setFields(OfjNxHashFields value)
NxActionMultipathBuilder
setMaxLink(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLink(Uint16)
instead.NxActionMultipathBuilder
setMaxLink(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionMultipathBuilder
setOfsNbits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOfsNbits(Uint16)
instead.NxActionMultipathBuilder
setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
NxActionMultipathBuilder
public NxActionMultipathBuilder()
-
NxActionMultipathBuilder
public NxActionMultipathBuilder(NxActionMultipath base)
-
-
Method Detail
-
getAlgorithm
public OfjNxMpAlgorithm getAlgorithm()
-
getArg
public org.opendaylight.yangtools.yang.common.Uint32 getArg()
-
getBasis
public org.opendaylight.yangtools.yang.common.Uint16 getBasis()
-
getDst
public org.opendaylight.yangtools.yang.common.Uint32 getDst()
-
getExperimenterId
public ExperimenterId getExperimenterId()
-
getFields
public OfjNxHashFields getFields()
-
getMaxLink
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLink()
-
getOfsNbits
public org.opendaylight.yangtools.yang.common.Uint16 getOfsNbits()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public NxActionMultipathBuilder setAlgorithm(OfjNxMpAlgorithm value)
-
setArg
public NxActionMultipathBuilder setArg(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setArg
@Deprecated(forRemoval=true) public NxActionMultipathBuilder setArg(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetArg(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBasis
public NxActionMultipathBuilder setBasis(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBasis
@Deprecated(forRemoval=true) public NxActionMultipathBuilder setBasis(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBasis(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDst
public NxActionMultipathBuilder setDst(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDst
@Deprecated(forRemoval=true) public NxActionMultipathBuilder setDst(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDst(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setExperimenterId
public NxActionMultipathBuilder setExperimenterId(ExperimenterId value)
-
setFields
public NxActionMultipathBuilder setFields(OfjNxHashFields value)
-
setMaxLink
public NxActionMultipathBuilder setMaxLink(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMaxLink
@Deprecated(forRemoval=true) public NxActionMultipathBuilder setMaxLink(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLink(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOfsNbits
public NxActionMultipathBuilder setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setOfsNbits
@Deprecated(forRemoval=true) public NxActionMultipathBuilder setOfsNbits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOfsNbits(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxActionMultipathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath> 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 NxActionMultipathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionMultipath>> 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 NxActionMultipath build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionMultipath>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionMultipath,IllegalArgumentException>
-
-