Class ProcessFlatBatchInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProcessFlatBatchInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProcessFlatBatchInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ProcessFlatBatchInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProcessFlatBatchInput>
Class that buildsProcessFlatBatchInputBuilder
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:
ProcessFlatBatchInputBuilder createTarget(int fooXyzzy, int barBaz) { return new ProcessFlatBatchInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProcessFlatBatchInputBuilder, 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 oportunities, 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:
ProcessFlatBatchInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProcessFlatBatchInputBuilder()
ProcessFlatBatchInputBuilder(ProcessFlatBatchInput base)
ProcessFlatBatchInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ProcessFlatBatchInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
ProcessFlatBatchInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<BatchKey,Batch>
getBatch()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
Boolean
isExitOnFirstError()
ProcessFlatBatchInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> augmentationType)
Remove an augmentation from this builder's product.ProcessFlatBatchInputBuilder
setBatch(List<Batch> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatch(Map)
instead.ProcessFlatBatchInputBuilder
setBatch(Map<BatchKey,Batch> values)
ProcessFlatBatchInputBuilder
setExitOnFirstError(Boolean value)
ProcessFlatBatchInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
-
-
Constructor Detail
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder()
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
ProcessFlatBatchInputBuilder
public ProcessFlatBatchInputBuilder(ProcessFlatBatchInput base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
isExitOnFirstError
public Boolean isExitOnFirstError()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBatch
public ProcessFlatBatchInputBuilder setBatch(Map<BatchKey,Batch> values)
-
setBatch
@Deprecated(forRemoval=true) public ProcessFlatBatchInputBuilder setBatch(List<Batch> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatch(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setNode
public ProcessFlatBatchInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setExitOnFirstError
public ProcessFlatBatchInputBuilder setExitOnFirstError(Boolean value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public ProcessFlatBatchInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProcessFlatBatchInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 ProcessFlatBatchInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProcessFlatBatchInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProcessFlatBatchInput,IllegalArgumentException>
-
-