Class RegValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.reg.grouping.RegValuesBuilder
-
@Generated("mdsal-binding-generator") public class RegValuesBuilder extends Object
Class that buildsRegValues
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:
RegValues createRegValues(int fooXyzzy, int barBaz) { return new RegValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RegValues, 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:
RegValues
- 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
-
-
Constructor Summary
Constructors Constructor Description RegValuesBuilder()
Construct an empty builder.RegValuesBuilder(RegValues base)
Construct a builder initialized with state from specifiedRegValues
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RegValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RegValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RegValues>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RegValues
build()
A newRegValues
instance.org.opendaylight.yangtools.yang.common.Uint32
getMask()
Return current value associated with the property corresponding toRegValues.getMask()
.org.opendaylight.yangtools.yang.common.Uint32
getValue()
Return current value associated with the property corresponding toRegValues.getValue()
.RegValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RegValues>> augmentationType)
Remove an augmentation from this builder's product.RegValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toRegValues.getMask()
to the specified value.RegValuesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toRegValues.getValue()
to the specified value.
-
-
-
Method Detail
-
getMask
public org.opendaylight.yangtools.yang.common.Uint32 getMask()
Return current value associated with the property corresponding toRegValues.getMask()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint32 getValue()
Return current value associated with the property corresponding toRegValues.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RegValues>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setMask
public RegValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toRegValues.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public RegValuesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toRegValues.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RegValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RegValues> 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 RegValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RegValues>> 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
-
-