Class FlatBatchRemoveGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.remove.group._case.FlatBatchRemoveGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlatBatchRemoveGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveGroup>
Class that buildsFlatBatchRemoveGroupBuilder
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:
FlatBatchRemoveGroupBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchRemoveGroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchRemoveGroupBuilder, 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:
FlatBatchRemoveGroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchRemoveGroupBuilder()
FlatBatchRemoveGroupBuilder(FlatBatchRemoveGroup base)
FlatBatchRemoveGroupBuilder(Group arg)
FlatBatchRemoveGroupBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchRemoveGroupBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.FlatBatchRemoveGroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchRemoveGroup
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()
FlatBatchRemoveGroupKey
key()
FlatBatchRemoveGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchRemoveGroupBuilder
setBarrier(Boolean value)
FlatBatchRemoveGroupBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.FlatBatchRemoveGroupBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveGroupBuilder
setBuckets(Buckets value)
FlatBatchRemoveGroupBuilder
setContainerName(String value)
FlatBatchRemoveGroupBuilder
setGroupId(GroupId value)
FlatBatchRemoveGroupBuilder
setGroupName(String value)
FlatBatchRemoveGroupBuilder
setGroupType(GroupTypes value)
FlatBatchRemoveGroupBuilder
withKey(FlatBatchRemoveGroupKey key)
-
-
-
Constructor Detail
-
FlatBatchRemoveGroupBuilder
public FlatBatchRemoveGroupBuilder()
-
FlatBatchRemoveGroupBuilder
public FlatBatchRemoveGroupBuilder(BatchOrderGrouping arg)
-
FlatBatchRemoveGroupBuilder
public FlatBatchRemoveGroupBuilder(Group arg)
-
FlatBatchRemoveGroupBuilder
public FlatBatchRemoveGroupBuilder(FlatBatchRemoveGroup 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 FlatBatchRemoveGroupKey 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<FlatBatchRemoveGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchRemoveGroupBuilder withKey(FlatBatchRemoveGroupKey key)
-
setBatchOrder
public FlatBatchRemoveGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchRemoveGroupBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBuckets
public FlatBatchRemoveGroupBuilder setBuckets(Buckets value)
-
setContainerName
public FlatBatchRemoveGroupBuilder setContainerName(String value)
-
setGroupId
public FlatBatchRemoveGroupBuilder setGroupId(GroupId value)
-
setGroupName
public FlatBatchRemoveGroupBuilder setGroupName(String value)
-
setGroupType
public FlatBatchRemoveGroupBuilder setGroupType(GroupTypes value)
-
setBarrier
public FlatBatchRemoveGroupBuilder setBarrier(Boolean value)
-
addAugmentation
public FlatBatchRemoveGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup> 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 FlatBatchRemoveGroupBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup> 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 FlatBatchRemoveGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>> 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 FlatBatchRemoveGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveGroup,IllegalArgumentException>
-
-