Class RemoveGroupInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInputBuilder
-
@Generated("mdsal-binding-generator") public class RemoveGroupInputBuilder extends Object
Class that buildsRemoveGroupInput
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:
RemoveGroupInput createRemoveGroupInput(int fooXyzzy, int barBaz) { return new RemoveGroupInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RemoveGroupInput, 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:
RemoveGroupInput
- 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 RemoveGroupInputBuilder()
Construct an empty builder.RemoveGroupInputBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.RemoveGroupInputBuilder(NodeGroup arg)
Construct a new builder initialized from specifiedNodeGroup
.RemoveGroupInputBuilder(RemoveGroupInput base)
Construct a builder initialized with state from specifiedRemoveGroupInput
.RemoveGroupInputBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.RemoveGroupInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RemoveGroupInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RemoveGroupInput
build()
A newRemoveGroupInput
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()
.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()
.GroupRef
getGroupRef()
Return current value associated with the property corresponding toRemoveGroupInput.getGroupRef()
.GroupTypes
getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.RemoveGroupInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput>> augmentationType)
Remove an augmentation from this builder's product.RemoveGroupInputBuilder
setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.RemoveGroupInputBuilder
setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.RemoveGroupInputBuilder
setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.RemoveGroupInputBuilder
setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.RemoveGroupInputBuilder
setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.RemoveGroupInputBuilder
setGroupRef(GroupRef value)
Set the property corresponding toRemoveGroupInput.getGroupRef()
to the specified value.RemoveGroupInputBuilder
setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.RemoveGroupInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.RemoveGroupInputBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.
-
-
-
Constructor Detail
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder()
Construct an empty builder.
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder(NodeGroup arg)
Construct a new builder initialized from specifiedNodeGroup
.- Parameters:
arg
- NodeGroup from which the builder should be initialized
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.- Parameters:
arg
- Group from which the builder should be initialized
-
RemoveGroupInputBuilder
public RemoveGroupInputBuilder(RemoveGroupInput base)
Construct a builder initialized with state from specifiedRemoveGroupInput
.- Parameters:
base
- RemoveGroupInput 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
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toGroup.getBarrier()
.- 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
-
getGroupRef
public GroupRef getGroupRef()
Return current value associated with the property corresponding toRemoveGroupInput.getGroupRef()
.- Returns:
- current value
-
getGroupType
public GroupTypes getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput>> 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
-
setBarrier
public RemoveGroupInputBuilder setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBuckets
public RemoveGroupInputBuilder setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public RemoveGroupInputBuilder setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
public RemoveGroupInputBuilder setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupName
public RemoveGroupInputBuilder setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupRef
public RemoveGroupInputBuilder setGroupRef(GroupRef value)
Set the property corresponding toRemoveGroupInput.getGroupRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupType
public RemoveGroupInputBuilder setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public RemoveGroupInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionUri
public RemoveGroupInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RemoveGroupInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput> 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 RemoveGroupInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupInput>> 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 RemoveGroupInput build()
A newRemoveGroupInput
instance.- Returns:
- A new
RemoveGroupInput
instance.
-
-