Class FlatBatchRemoveGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.group.crud._case.aug.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>
@Generated("mdsal-binding-generator") public class FlatBatchRemoveGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveGroup>
Class that buildsFlatBatchRemoveGroup
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:
FlatBatchRemoveGroup createFlatBatchRemoveGroup(int fooXyzzy, int barBaz) { return new FlatBatchRemoveGroupBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchRemoveGroup, 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 opportunities, 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:
FlatBatchRemoveGroup
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchRemoveGroupBuilder()
FlatBatchRemoveGroupBuilder(FlatBatchRemoveGroup base)
FlatBatchRemoveGroupBuilder(Group arg)
FlatBatchRemoveGroupBuilder(BatchOrderGrouping arg)
-
Method Summary
-
-
-
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:- Group
- BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchRemoveGroupKey key()
-
getBarrier
public Boolean getBarrier()
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchRemoveGroupBuilder withKey(FlatBatchRemoveGroupKey key)
-
setBarrier
public FlatBatchRemoveGroupBuilder setBarrier(Boolean value)
-
setBatchOrder
public FlatBatchRemoveGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
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)
-
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
-
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>
-
-