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