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