Class ProcessFlatBatchInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchInputBuilder
-
@Generated("mdsal-binding-generator") public class ProcessFlatBatchInputBuilder extends Object
Class that buildsProcessFlatBatchInput
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:
ProcessFlatBatchInput createProcessFlatBatchInput(int fooXyzzy, int barBaz) { return new ProcessFlatBatchInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProcessFlatBatchInput, 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:
ProcessFlatBatchInput
- 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 ProcessFlatBatchInputBuilder()
Construct an empty builder.ProcessFlatBatchInputBuilder(ProcessFlatBatchInput base)
Construct a builder initialized with state from specifiedProcessFlatBatchInput
.ProcessFlatBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessFlatBatchInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ProcessFlatBatchInput
build()
A newProcessFlatBatchInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<BatchKey,Batch>
getBatch()
Return current value associated with the property corresponding toProcessFlatBatchInput.getBatch()
.Boolean
getExitOnFirstError()
Return current value associated with the property corresponding toProcessFlatBatchInput.getExitOnFirstError()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.ProcessFlatBatchInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> augmentationType)
Remove an augmentation from this builder's product.ProcessFlatBatchInputBuilder
setBatch(Map<BatchKey,Batch> values)
Set the property corresponding toProcessFlatBatchInput.getBatch()
to the specified value.ProcessFlatBatchInputBuilder
setExitOnFirstError(Boolean value)
Set the property corresponding toProcessFlatBatchInput.getExitOnFirstError()
to the specified value.ProcessFlatBatchInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.
-
-
-
Constructor Detail
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder()
Construct an empty builder.
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder(ProcessFlatBatchInput base)
Construct a builder initialized with state from specifiedProcessFlatBatchInput
.- Parameters:
base
- ProcessFlatBatchInput 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
-
getBatch
public Map<BatchKey,Batch> getBatch()
Return current value associated with the property corresponding toProcessFlatBatchInput.getBatch()
.- Returns:
- current value
-
getExitOnFirstError
public Boolean getExitOnFirstError()
Return current value associated with the property corresponding toProcessFlatBatchInput.getExitOnFirstError()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> 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
-
setBatch
public ProcessFlatBatchInputBuilder setBatch(Map<BatchKey,Batch> values)
Set the property corresponding toProcessFlatBatchInput.getBatch()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setExitOnFirstError
public ProcessFlatBatchInputBuilder setExitOnFirstError(Boolean value)
Set the property corresponding toProcessFlatBatchInput.getExitOnFirstError()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public ProcessFlatBatchInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ProcessFlatBatchInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput> 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 ProcessFlatBatchInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> 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 ProcessFlatBatchInput build()
A newProcessFlatBatchInput
instance.- Returns:
- A new
ProcessFlatBatchInput
instance.
-
-