Package org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.remove.groups.batch.input
Class BatchRemoveGroupsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.remove.groups.batch.input.BatchRemoveGroupsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchRemoveGroups>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveGroups,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BatchRemoveGroupsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchRemoveGroups>
Class that buildsBatchRemoveGroupsBuilder
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:
BatchRemoveGroupsBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchRemoveGroupsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchRemoveGroupsBuilder, 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:
BatchRemoveGroupsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchRemoveGroupsBuilder()
BatchRemoveGroupsBuilder(Group arg)
BatchRemoveGroupsBuilder(BatchRemoveGroups base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchRemoveGroupsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveGroups> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveGroups>>
E$$augmentation(Class<E$$> augmentationType)
BatchRemoveGroups
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Buckets
getBuckets()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
Boolean
isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.BatchRemoveGroupsKey
key()
BatchRemoveGroupsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveGroups>> augmentationType)
Remove an augmentation from this builder's product.BatchRemoveGroupsBuilder
setBarrier(Boolean value)
BatchRemoveGroupsBuilder
setBuckets(Buckets value)
BatchRemoveGroupsBuilder
setContainerName(String value)
BatchRemoveGroupsBuilder
setGroupId(GroupId value)
BatchRemoveGroupsBuilder
setGroupName(String value)
BatchRemoveGroupsBuilder
setGroupType(GroupTypes value)
BatchRemoveGroupsBuilder
withKey(BatchRemoveGroupsKey key)
-
-
-
Constructor Detail
-
BatchRemoveGroupsBuilder
public BatchRemoveGroupsBuilder()
-
BatchRemoveGroupsBuilder
public BatchRemoveGroupsBuilder(Group arg)
-
BatchRemoveGroupsBuilder
public BatchRemoveGroupsBuilder(BatchRemoveGroups 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 or has property with incompatible value
-
key
public BatchRemoveGroupsKey key()
-
getBarrier
public Boolean getBarrier()
-
isBarrier
@Deprecated(forRemoval=true) public final Boolean isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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<BatchRemoveGroups>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchRemoveGroupsBuilder withKey(BatchRemoveGroupsKey key)
-
setBarrier
public BatchRemoveGroupsBuilder setBarrier(Boolean value)
-
setBuckets
public BatchRemoveGroupsBuilder setBuckets(Buckets value)
-
setContainerName
public BatchRemoveGroupsBuilder setContainerName(String value)
-
setGroupId
public BatchRemoveGroupsBuilder setGroupId(GroupId value)
-
setGroupName
public BatchRemoveGroupsBuilder setGroupName(String value)
-
setGroupType
public BatchRemoveGroupsBuilder setGroupType(GroupTypes value)
-
addAugmentation
public BatchRemoveGroupsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveGroups> 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 BatchRemoveGroupsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveGroups>> 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 BatchRemoveGroups build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchRemoveGroups>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveGroups,IllegalArgumentException>
-
-