Class NxOutputRegBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.output.reg.grouping.NxOutputRegBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxOutputReg>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxOutputReg,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxOutputRegBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxOutputReg>
Class that buildsNxOutputRegBuilder
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:
NxOutputRegBuilder createTarget(int fooXyzzy, int barBaz) { return new NxOutputRegBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxOutputRegBuilder, 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:
NxOutputRegBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxOutputRegBuilder()
NxOutputRegBuilder(NxOutputReg base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxOutputRegBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>>
E$$augmentation(Class<E$$> augmentationType)
NxOutputReg
build()
org.opendaylight.yangtools.yang.common.Uint16
getMaxLen()
Src
getSrc()
NxOutputRegBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType)
NxOutputRegBuilder
setMaxLen(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxLen(Uint16)} instead.NxOutputRegBuilder
setMaxLen(org.opendaylight.yangtools.yang.common.Uint16 value)
NxOutputRegBuilder
setSrc(Src value)
-
-
-
Constructor Detail
-
NxOutputRegBuilder
public NxOutputRegBuilder()
-
NxOutputRegBuilder
public NxOutputRegBuilder(NxOutputReg base)
-
-
Method Detail
-
getMaxLen
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLen()
-
getSrc
public Src getSrc()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaxLen
public NxOutputRegBuilder setMaxLen(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMaxLen
@Deprecated(forRemoval=true) public NxOutputRegBuilder setMaxLen(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxLen(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrc
public NxOutputRegBuilder setSrc(Src value)
-
addAugmentation
public NxOutputRegBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg> augmentationValue)
-
removeAugmentation
public NxOutputRegBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType)
-
build
public NxOutputReg build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxOutputReg>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxOutputReg,IllegalArgumentException>
-
-