Class NxMultipathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.multipath.grouping.NxMultipathBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxMultipath>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxMultipath,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxMultipathBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxMultipath>
Class that buildsNxMultipath
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:
NxMultipath createNxMultipath(int fooXyzzy, int barBaz) { return new NxMultipathBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxMultipath, 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:
NxMultipath
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxMultipathBuilder()
NxMultipathBuilder(NxMultipath base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxMultipathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>>
E$$augmentation(Class<E$$> augmentationType)
NxMultipath
build()
OfjNxMpAlgorithm
getAlgorithm()
org.opendaylight.yangtools.yang.common.Uint32
getArg()
org.opendaylight.yangtools.yang.common.Uint16
getBasis()
Dst
getDst()
OfjNxHashFields
getFields()
org.opendaylight.yangtools.yang.common.Uint16
getMaxLink()
NxMultipathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> augmentationType)
Remove an augmentation from this builder's product.NxMultipathBuilder
setAlgorithm(OfjNxMpAlgorithm value)
NxMultipathBuilder
setArg(org.opendaylight.yangtools.yang.common.Uint32 value)
NxMultipathBuilder
setBasis(org.opendaylight.yangtools.yang.common.Uint16 value)
NxMultipathBuilder
setDst(Dst value)
NxMultipathBuilder
setFields(OfjNxHashFields value)
NxMultipathBuilder
setMaxLink(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
NxMultipathBuilder
public NxMultipathBuilder()
-
NxMultipathBuilder
public NxMultipathBuilder(NxMultipath 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 Dst getDst()
-
getFields
public OfjNxHashFields getFields()
-
getMaxLink
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLink()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public NxMultipathBuilder setAlgorithm(OfjNxMpAlgorithm value)
-
setArg
public NxMultipathBuilder setArg(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBasis
public NxMultipathBuilder setBasis(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDst
public NxMultipathBuilder setDst(Dst value)
-
setFields
public NxMultipathBuilder setFields(OfjNxHashFields value)
-
setMaxLink
public NxMultipathBuilder setMaxLink(org.opendaylight.yangtools.yang.common.Uint16 value)
-
addAugmentation
public NxMultipathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath> 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 NxMultipathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> 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 NxMultipath build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxMultipath>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxMultipath,IllegalArgumentException>
-
-