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