Class NxRegLoadBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.NxRegLoadBuilder
-
@Generated("mdsal-binding-generator") public class NxRegLoadBuilder extends Object
Class that buildsNxRegLoad
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:
NxRegLoad createNxRegLoad(int fooXyzzy, int barBaz) { return new NxRegLoadBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxRegLoad, 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:
NxRegLoad
- 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 NxRegLoadBuilder()
Construct an empty builder.NxRegLoadBuilder(NxRegLoad base)
Construct a builder initialized with state from specifiedNxRegLoad
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxRegLoadBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxRegLoad
build()
A newNxRegLoad
instance.Dst
getDst()
Return current value associated with the property corresponding toNxRegLoad.getDst()
.org.opendaylight.yangtools.yang.common.Uint64
getValue()
Return current value associated with the property corresponding toNxRegLoad.getValue()
.NxRegLoadBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad>> augmentationType)
Remove an augmentation from this builder's product.NxRegLoadBuilder
setDst(Dst value)
Set the property corresponding toNxRegLoad.getDst()
to the specified value.NxRegLoadBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxRegLoad.getValue()
to the specified value.
-
-
-
Method Detail
-
getDst
public Dst getDst()
Return current value associated with the property corresponding toNxRegLoad.getDst()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint64 getValue()
Return current value associated with the property corresponding toNxRegLoad.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad>> 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
-
setDst
public NxRegLoadBuilder setDst(Dst value)
Set the property corresponding toNxRegLoad.getDst()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public NxRegLoadBuilder setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toNxRegLoad.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxRegLoadBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad> 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 NxRegLoadBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxRegLoad>> 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
-
-