Class NxActionRegLoadBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.reg.load.grouping.NxActionRegLoadBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionRegLoad>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionRegLoad,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxActionRegLoadBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionRegLoad>
Class that buildsNxActionRegLoadBuilder
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:
NxActionRegLoadBuilder createTarget(int fooXyzzy, int barBaz) { return new NxActionRegLoadBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionRegLoadBuilder, 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:
NxActionRegLoadBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionRegLoadBuilder()
NxActionRegLoadBuilder(NxActionRegLoad base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxActionRegLoadBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>>
E$$augmentation(Class<E$$> augmentationType)
NxActionRegLoad
build()
org.opendaylight.yangtools.yang.common.Uint32
getDst()
ExperimenterId
getExperimenterId()
org.opendaylight.yangtools.yang.common.Uint16
getOfsNbits()
org.opendaylight.yangtools.yang.common.Uint64
getValue()
NxActionRegLoadBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>> augmentationType)
NxActionRegLoadBuilder
setDst(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDst(Uint32)} instead.NxActionRegLoadBuilder
setDst(org.opendaylight.yangtools.yang.common.Uint32 value)
NxActionRegLoadBuilder
setExperimenterId(ExperimenterId value)
NxActionRegLoadBuilder
setOfsNbits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOfsNbits(Uint16)} instead.NxActionRegLoadBuilder
setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionRegLoadBuilder
setValue(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint64)} instead.NxActionRegLoadBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
NxActionRegLoadBuilder
public NxActionRegLoadBuilder()
-
NxActionRegLoadBuilder
public NxActionRegLoadBuilder(NxActionRegLoad base)
-
-
Method Detail
-
getDst
public org.opendaylight.yangtools.yang.common.Uint32 getDst()
-
getExperimenterId
public ExperimenterId getExperimenterId()
-
getOfsNbits
public org.opendaylight.yangtools.yang.common.Uint16 getOfsNbits()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint64 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>> E$$ augmentation(Class<E$$> augmentationType)
-
setDst
public NxActionRegLoadBuilder setDst(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDst
@Deprecated(forRemoval=true) public NxActionRegLoadBuilder setDst(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDst(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setExperimenterId
public NxActionRegLoadBuilder setExperimenterId(ExperimenterId value)
-
setOfsNbits
public NxActionRegLoadBuilder setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setOfsNbits
@Deprecated(forRemoval=true) public NxActionRegLoadBuilder setOfsNbits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOfsNbits(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setValue
public NxActionRegLoadBuilder setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setValue
@Deprecated(forRemoval=true) public NxActionRegLoadBuilder setValue(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxActionRegLoadBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad> augmentationValue)
-
removeAugmentation
public NxActionRegLoadBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad>> augmentationType)
-
build
public NxActionRegLoad build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionRegLoad>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionRegLoad,IllegalArgumentException>
-
-