Class NspValuesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.nsp.grouping.NspValuesBuilder
Class that builds
NspValues
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:
NspValues createNspValues(int fooXyzzy, int barBaz) {
return new NspValuesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NspValues, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.NspValuesBuilder
(NspValues base) Construct a builder initialized with state from specifiedNspValues
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NspValues> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NspValues>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull NspValues
build()
A newNspValues
instance.static @NonNull NspValues
empty()
Get empty instance of NspValues.org.opendaylight.yangtools.yang.common.Uint32
getMask()
Return current value associated with the property corresponding toNspValues.getMask()
.org.opendaylight.yangtools.yang.common.Uint32
getNsp()
Return current value associated with the property corresponding toNspValues.getNsp()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NspValues>> augmentationType) Remove an augmentation from this builder's product.setMask
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toNspValues.getMask()
to the specified value.setNsp
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toNspValues.getNsp()
to the specified value.
-
Constructor Details
-
NspValuesBuilder
public NspValuesBuilder()Construct an empty builder. -
NspValuesBuilder
Construct a builder initialized with state from specifiedNspValues
.- Parameters:
base
- NspValues from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of NspValues.- Returns:
- An empty
NspValues
-
getMask
public org.opendaylight.yangtools.yang.common.Uint32 getMask()Return current value associated with the property corresponding toNspValues.getMask()
.- Returns:
- current value
-
getNsp
public org.opendaylight.yangtools.yang.common.Uint32 getNsp()Return current value associated with the property corresponding toNspValues.getNsp()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NspValues>> 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
Set the property corresponding toNspValues.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNsp
Set the property corresponding toNspValues.getNsp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NspValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NspValues> 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 NspValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NspValues>> 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
A newNspValues
instance.- Returns:
- A new
NspValues
instance.
-