Class CommitActiveBundleInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.arbitrator.reconcile.service.rev180227.CommitActiveBundleInputBuilder
-
@Generated("mdsal-binding-generator") public class CommitActiveBundleInputBuilder extends Object
Class that buildsCommitActiveBundleInput
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:
CommitActiveBundleInput createCommitActiveBundleInput(int fooXyzzy, int barBaz) { return new CommitActiveBundleInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CommitActiveBundleInput, 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:
CommitActiveBundleInput
- 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 CommitActiveBundleInputBuilder()
Construct an empty builder.CommitActiveBundleInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.CommitActiveBundleInputBuilder(CommitActiveBundleInput base)
Construct a builder initialized with state from specifiedCommitActiveBundleInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommitActiveBundleInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull CommitActiveBundleInput
build()
A newCommitActiveBundleInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.org.opendaylight.yangtools.yang.common.Uint64
getNodeId()
Return current value associated with the property corresponding toCommitActiveBundleInput.getNodeId()
.CommitActiveBundleInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput>> augmentationType)
Remove an augmentation from this builder's product.CommitActiveBundleInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.CommitActiveBundleInputBuilder
setNodeId(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toCommitActiveBundleInput.getNodeId()
to the specified value.
-
-
-
Constructor Detail
-
CommitActiveBundleInputBuilder
public CommitActiveBundleInputBuilder()
Construct an empty builder.
-
CommitActiveBundleInputBuilder
public CommitActiveBundleInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
CommitActiveBundleInputBuilder
public CommitActiveBundleInputBuilder(CommitActiveBundleInput base)
Construct a builder initialized with state from specifiedCommitActiveBundleInput
.- Parameters:
base
- CommitActiveBundleInput from which the builder should be initialized
-
-
Method Detail
-
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
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getNodeId
public org.opendaylight.yangtools.yang.common.Uint64 getNodeId()
Return current value associated with the property corresponding toCommitActiveBundleInput.getNodeId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput>> 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
-
setNode
public CommitActiveBundleInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNodeId
public CommitActiveBundleInputBuilder setNodeId(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toCommitActiveBundleInput.getNodeId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CommitActiveBundleInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput> 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 CommitActiveBundleInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleInput>> 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
public @NonNull CommitActiveBundleInput build()
A newCommitActiveBundleInput
instance.- Returns:
- A new
CommitActiveBundleInput
instance.
-
-