Package org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.add.groups.batch.input
Class BatchAddGroupsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.add.groups.batch.input.BatchAddGroupsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchAddGroups>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchAddGroups,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchAddGroupsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchAddGroups>
Class that buildsBatchAddGroupsBuilder
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:
BatchAddGroupsBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchAddGroupsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchAddGroupsBuilder, 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:
BatchAddGroupsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchAddGroupsBuilder()
BatchAddGroupsBuilder(Group arg)
BatchAddGroupsBuilder(BatchAddGroups base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchAddGroupsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BatchAddGroupsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups>>
E$$augmentation(Class<E$$> augmentationType)
BatchAddGroups
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Buckets
getBuckets()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
Boolean
isBarrier()
BatchAddGroupsKey
key()
BatchAddGroupsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups>> augmentationType)
Remove an augmentation from this builder's product.BatchAddGroupsBuilder
setBarrier(Boolean value)
BatchAddGroupsBuilder
setBuckets(Buckets value)
BatchAddGroupsBuilder
setContainerName(String value)
BatchAddGroupsBuilder
setGroupId(GroupId value)
BatchAddGroupsBuilder
setGroupName(String value)
BatchAddGroupsBuilder
setGroupType(GroupTypes value)
BatchAddGroupsBuilder
withKey(BatchAddGroupsKey key)
-
-
-
Constructor Detail
-
BatchAddGroupsBuilder
public BatchAddGroupsBuilder()
-
BatchAddGroupsBuilder
public BatchAddGroupsBuilder(Group arg)
-
BatchAddGroupsBuilder
public BatchAddGroupsBuilder(BatchAddGroups 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
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchAddGroupsKey key()
-
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<BatchAddGroups>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchAddGroupsBuilder withKey(BatchAddGroupsKey key)
-
setBuckets
public BatchAddGroupsBuilder setBuckets(Buckets value)
-
setContainerName
public BatchAddGroupsBuilder setContainerName(String value)
-
setGroupId
public BatchAddGroupsBuilder setGroupId(GroupId value)
-
setGroupName
public BatchAddGroupsBuilder setGroupName(String value)
-
setGroupType
public BatchAddGroupsBuilder setGroupType(GroupTypes value)
-
setBarrier
public BatchAddGroupsBuilder setBarrier(Boolean value)
-
addAugmentation
public BatchAddGroupsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups> 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 BatchAddGroupsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups> 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 BatchAddGroupsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddGroups>> 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 BatchAddGroups build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchAddGroups>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchAddGroups,IllegalArgumentException>
-
-