Class FlatBatchAddGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.add.group._case.FlatBatchAddGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchAddGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchAddGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlatBatchAddGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchAddGroup>
Class that buildsFlatBatchAddGroupBuilder
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:
FlatBatchAddGroupBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchAddGroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchAddGroupBuilder, 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:
FlatBatchAddGroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchAddGroupBuilder()
FlatBatchAddGroupBuilder(FlatBatchAddGroup base)
FlatBatchAddGroupBuilder(Group arg)
FlatBatchAddGroupBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchAddGroupBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchAddGroup
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
Buckets
getBuckets()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
Boolean
isBarrier()
FlatBatchAddGroupKey
key()
FlatBatchAddGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> augmentationType)
FlatBatchAddGroupBuilder
setBarrier(Boolean value)
FlatBatchAddGroupBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.FlatBatchAddGroupBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchAddGroupBuilder
setBuckets(Buckets value)
FlatBatchAddGroupBuilder
setContainerName(String value)
FlatBatchAddGroupBuilder
setGroupId(GroupId value)
FlatBatchAddGroupBuilder
setGroupName(String value)
FlatBatchAddGroupBuilder
setGroupType(GroupTypes value)
FlatBatchAddGroupBuilder
withKey(FlatBatchAddGroupKey key)
-
-
-
Constructor Detail
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder()
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(BatchOrderGrouping arg)
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(Group arg)
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(FlatBatchAddGroup 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.group.types.rev131018.Group
- 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 FlatBatchAddGroupKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getBuckets
public Buckets getBuckets()
-
getContainerName
public String getContainerName()
-
getGroupId
public GroupId getGroupId()
-
getGroupName
public String getGroupName()
-
getGroupType
public GroupTypes getGroupType()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchAddGroupBuilder withKey(FlatBatchAddGroupKey key)
-
setBatchOrder
public FlatBatchAddGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchAddGroupBuilder 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
-
setBuckets
public FlatBatchAddGroupBuilder setBuckets(Buckets value)
-
setContainerName
public FlatBatchAddGroupBuilder setContainerName(String value)
-
setGroupId
public FlatBatchAddGroupBuilder setGroupId(GroupId value)
-
setGroupName
public FlatBatchAddGroupBuilder setGroupName(String value)
-
setGroupType
public FlatBatchAddGroupBuilder setGroupType(GroupTypes value)
-
setBarrier
public FlatBatchAddGroupBuilder setBarrier(Boolean value)
-
addAugmentation
public FlatBatchAddGroupBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup> augmentationValue)
-
removeAugmentation
public FlatBatchAddGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> augmentationType)
-
build
public FlatBatchAddGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchAddGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchAddGroup,IllegalArgumentException>
-
-