Class FlatBatchAddGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.group.crud._case.aug.flat.batch.add.group._case.FlatBatchAddGroupBuilder
-
@Generated("mdsal-binding-generator") public class FlatBatchAddGroupBuilder extends Object
Class that buildsFlatBatchAddGroup
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:
FlatBatchAddGroup createFlatBatchAddGroup(int fooXyzzy, int barBaz) { return new FlatBatchAddGroupBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchAddGroup, 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:
FlatBatchAddGroup
- 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
-
-
Constructor Summary
Constructors Constructor Description FlatBatchAddGroupBuilder()
Construct an empty builder.FlatBatchAddGroupBuilder(FlatBatchAddGroup base)
Construct a builder initialized with state from specifiedFlatBatchAddGroup
.FlatBatchAddGroupBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.FlatBatchAddGroupBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatBatchAddGroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlatBatchAddGroup
build()
A newFlatBatchAddGroup
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Return current value associated with the property corresponding toGroup.getBarrier()
.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
Return current value associated with the property corresponding toBatchOrderGrouping.getBatchOrder()
.Buckets
getBuckets()
Return current value associated with the property corresponding toGroup.getBuckets()
.String
getContainerName()
Return current value associated with the property corresponding toGroup.getContainerName()
.GroupId
getGroupId()
Return current value associated with the property corresponding toGroup.getGroupId()
.String
getGroupName()
Return current value associated with the property corresponding toGroup.getGroupName()
.GroupTypes
getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.FlatBatchAddGroupKey
key()
Return current value associated with the property corresponding toFlatBatchAddGroup.key()
.FlatBatchAddGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchAddGroupBuilder
setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.FlatBatchAddGroupBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.FlatBatchAddGroupBuilder
setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.FlatBatchAddGroupBuilder
setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.FlatBatchAddGroupBuilder
setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.FlatBatchAddGroupBuilder
setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.FlatBatchAddGroupBuilder
setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.FlatBatchAddGroupBuilder
withKey(FlatBatchAddGroupKey key)
-
-
-
Constructor Detail
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder()
Construct an empty builder.
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.- Parameters:
arg
- BatchOrderGrouping from which the builder should be initialized
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.- Parameters:
arg
- Group from which the builder should be initialized
-
FlatBatchAddGroupBuilder
public FlatBatchAddGroupBuilder(FlatBatchAddGroup base)
Construct a builder initialized with state from specifiedFlatBatchAddGroup
.- Parameters:
base
- FlatBatchAddGroup from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchAddGroupKey key()
Return current value associated with the property corresponding toFlatBatchAddGroup.key()
.- Returns:
- current value
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toGroup.getBarrier()
.- Returns:
- current value
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
Return current value associated with the property corresponding toBatchOrderGrouping.getBatchOrder()
.- Returns:
- current value
-
getBuckets
public Buckets getBuckets()
Return current value associated with the property corresponding toGroup.getBuckets()
.- Returns:
- current value
-
getContainerName
public String getContainerName()
Return current value associated with the property corresponding toGroup.getContainerName()
.- Returns:
- current value
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toGroup.getGroupId()
.- Returns:
- current value
-
getGroupName
public String getGroupName()
Return current value associated with the property corresponding toGroup.getGroupName()
.- Returns:
- current value
-
getGroupType
public GroupTypes getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public FlatBatchAddGroupBuilder withKey(FlatBatchAddGroupKey key)
-
setBarrier
public FlatBatchAddGroupBuilder setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBatchOrder
public FlatBatchAddGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBuckets
public FlatBatchAddGroupBuilder setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public FlatBatchAddGroupBuilder setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
public FlatBatchAddGroupBuilder setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupName
public FlatBatchAddGroupBuilder setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupType
public FlatBatchAddGroupBuilder setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlatBatchAddGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup> 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 FlatBatchAddGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> 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 @NonNull FlatBatchAddGroup build()
A newFlatBatchAddGroup
instance.- Returns:
- A new
FlatBatchAddGroup
instance.
-
-