Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input
Class BatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.BatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Batch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Batch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Batch>
Class that buildsBatchBuilder
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:
BatchBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchBuilder, 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:
BatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchBuilder()
BatchBuilder(Batch base)
BatchBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Batch> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>>
E$$augmentation(Class<E$$> augmentationType)
Batch
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BatchChoice
getBatchChoice()
org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
BatchKey
key()
BatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> augmentationType)
BatchBuilder
setBatchChoice(BatchChoice value)
BatchBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.BatchBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchBuilder
withKey(BatchKey key)
-
-
-
Constructor Detail
-
BatchBuilder
public BatchBuilder()
-
BatchBuilder
public BatchBuilder(BatchOrderGrouping arg)
-
BatchBuilder
public BatchBuilder(Batch 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.service.batch.common.rev160322.BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchKey key()
-
getBatchChoice
public BatchChoice getBatchChoice()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchBuilder withKey(BatchKey key)
-
setBatchChoice
public BatchBuilder setBatchChoice(BatchChoice value)
-
setBatchOrder
public BatchBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public BatchBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public BatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Batch> augmentationValue)
-
removeAugmentation
public BatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> augmentationType)
-
build
public Batch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Batch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Batch,IllegalArgumentException>
-
-