Class NxmNxRegBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.reg.grouping.NxmNxRegBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmNxReg>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxReg,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxmNxRegBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmNxReg>
Class that buildsNxmNxRegBuilder
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:
NxmNxRegBuilder createTarget(int fooXyzzy, int barBaz) { return new NxmNxRegBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmNxRegBuilder, 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:
NxmNxRegBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmNxRegBuilder()
NxmNxRegBuilder(NxmNxReg base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxmNxRegBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>>
E$$augmentation(Class<E$$> augmentationType)
NxmNxReg
build()
org.opendaylight.yangtools.yang.common.Uint32
getMask()
Class<? extends NxmNxReg>
getReg()
org.opendaylight.yangtools.yang.common.Uint32
getValue()
NxmNxRegBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> augmentationType)
Remove an augmentation from this builder's product.NxmNxRegBuilder
setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint32)
instead.NxmNxRegBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
NxmNxRegBuilder
setReg(Class<? extends NxmNxReg> value)
NxmNxRegBuilder
setValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint32)
instead.NxmNxRegBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
NxmNxRegBuilder
public NxmNxRegBuilder()
-
NxmNxRegBuilder
public NxmNxRegBuilder(NxmNxReg base)
-
-
Method Detail
-
getMask
public org.opendaylight.yangtools.yang.common.Uint32 getMask()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint32 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public NxmNxRegBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMask
@Deprecated(forRemoval=true) public NxmNxRegBuilder setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setReg
public NxmNxRegBuilder setReg(Class<? extends NxmNxReg> value)
-
setValue
public NxmNxRegBuilder setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setValue
@Deprecated(forRemoval=true) public NxmNxRegBuilder setValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxmNxRegBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg> 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 NxmNxRegBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> 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 NxmNxReg build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmNxReg>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxReg,IllegalArgumentException>
-
-