Class FlatBatchUpdateGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.update.group._case.FlatBatchUpdateGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlatBatchUpdateGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateGroup>
Class that buildsFlatBatchUpdateGroupBuilder
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:
FlatBatchUpdateGroupBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchUpdateGroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchUpdateGroupBuilder, 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:
FlatBatchUpdateGroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchUpdateGroupBuilder()
FlatBatchUpdateGroupBuilder(FlatBatchUpdateGroup base)
FlatBatchUpdateGroupBuilder(BatchGroupInputUpdateGrouping arg)
FlatBatchUpdateGroupBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchUpdateGroupBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchUpdateGroup
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
OriginalBatchedGroup
getOriginalBatchedGroup()
UpdatedBatchedGroup
getUpdatedBatchedGroup()
FlatBatchUpdateGroupKey
key()
FlatBatchUpdateGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>> augmentationType)
FlatBatchUpdateGroupBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.FlatBatchUpdateGroupBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchUpdateGroupBuilder
setOriginalBatchedGroup(OriginalBatchedGroup value)
FlatBatchUpdateGroupBuilder
setUpdatedBatchedGroup(UpdatedBatchedGroup value)
FlatBatchUpdateGroupBuilder
withKey(FlatBatchUpdateGroupKey key)
-
-
-
Constructor Detail
-
FlatBatchUpdateGroupBuilder
public FlatBatchUpdateGroupBuilder()
-
FlatBatchUpdateGroupBuilder
public FlatBatchUpdateGroupBuilder(BatchOrderGrouping arg)
-
FlatBatchUpdateGroupBuilder
public FlatBatchUpdateGroupBuilder(BatchGroupInputUpdateGrouping arg)
-
FlatBatchUpdateGroupBuilder
public FlatBatchUpdateGroupBuilder(FlatBatchUpdateGroup 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.groups.service.rev160315.BatchGroupInputUpdateGrouping
- 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 FlatBatchUpdateGroupKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getOriginalBatchedGroup
public OriginalBatchedGroup getOriginalBatchedGroup()
-
getUpdatedBatchedGroup
public UpdatedBatchedGroup getUpdatedBatchedGroup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchUpdateGroupBuilder withKey(FlatBatchUpdateGroupKey key)
-
setBatchOrder
public FlatBatchUpdateGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchUpdateGroupBuilder 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
-
setOriginalBatchedGroup
public FlatBatchUpdateGroupBuilder setOriginalBatchedGroup(OriginalBatchedGroup value)
-
setUpdatedBatchedGroup
public FlatBatchUpdateGroupBuilder setUpdatedBatchedGroup(UpdatedBatchedGroup value)
-
addAugmentation
public FlatBatchUpdateGroupBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup> augmentationValue)
-
removeAugmentation
public FlatBatchUpdateGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateGroup>> augmentationType)
-
build
public FlatBatchUpdateGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateGroup,IllegalArgumentException>
-
-