Class NxActionLearnRpcTransmitPacketCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.transmit.packet.input.action.action.NxActionLearnRpcTransmitPacketCaseBuilder
@Generated("mdsal-binding-generator")
public class NxActionLearnRpcTransmitPacketCaseBuilder
extends Object
Class that builds
NxActionLearnRpcTransmitPacketCase
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:
NxActionLearnRpcTransmitPacketCase createNxActionLearnRpcTransmitPacketCase(int fooXyzzy, int barBaz) {
return new NxActionLearnRpcTransmitPacketCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NxActionLearnRpcTransmitPacketCase, 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 new builder initialized from specifiedNxActionLearnGrouping
.Construct a builder initialized with state from specifiedNxActionLearnRpcTransmitPacketCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull NxActionLearnRpcTransmitPacketCase
build()
A newNxActionLearnRpcTransmitPacketCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toNxActionLearnGrouping.getNxLearn()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase>> augmentationType) Remove an augmentation from this builder's product.setNxLearn
(NxLearn value) Set the property corresponding toNxActionLearnGrouping.getNxLearn()
to the specified value.
-
Constructor Details
-
NxActionLearnRpcTransmitPacketCaseBuilder
public NxActionLearnRpcTransmitPacketCaseBuilder()Construct an empty builder. -
NxActionLearnRpcTransmitPacketCaseBuilder
Construct a new builder initialized from specifiedNxActionLearnGrouping
.- Parameters:
arg
- NxActionLearnGrouping from which the builder should be initialized
-
NxActionLearnRpcTransmitPacketCaseBuilder
Construct a builder initialized with state from specifiedNxActionLearnRpcTransmitPacketCase
.- Parameters:
base
- NxActionLearnRpcTransmitPacketCase from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNxLearn
Return current value associated with the property corresponding toNxActionLearnGrouping.getNxLearn()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase>> 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
-
setNxLearn
Set the property corresponding toNxActionLearnGrouping.getNxLearn()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionLearnRpcTransmitPacketCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase> 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 NxActionLearnRpcTransmitPacketCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearnRpcTransmitPacketCase>> 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 newNxActionLearnRpcTransmitPacketCase
instance.- Returns:
- A new
NxActionLearnRpcTransmitPacketCase
instance.
-