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