Class RemoveGroupsBatchInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.RemoveGroupsBatchInputBuilder
-
@Generated("mdsal-binding-generator") public class RemoveGroupsBatchInputBuilder extends Object
Class that buildsRemoveGroupsBatchInput
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:
RemoveGroupsBatchInput createRemoveGroupsBatchInput(int fooXyzzy, int barBaz) { return new RemoveGroupsBatchInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RemoveGroupsBatchInput, 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:
RemoveGroupsBatchInput
- 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 RemoveGroupsBatchInputBuilder()
Construct an empty builder.RemoveGroupsBatchInputBuilder(RemoveGroupsBatchInput base)
Construct a builder initialized with state from specifiedRemoveGroupsBatchInput
.RemoveGroupsBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.RemoveGroupsBatchInputBuilder(BarrierSuffix arg)
Construct a new builder initialized from specifiedBarrierSuffix
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RemoveGroupsBatchInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RemoveGroupsBatchInput
build()
A newRemoveGroupsBatchInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrierAfter()
Return current value associated with the property corresponding toBarrierSuffix.getBarrierAfter()
.Map<BatchRemoveGroupsKey,BatchRemoveGroups>
getBatchRemoveGroups()
Return current value associated with the property corresponding toRemoveGroupsBatchInput.getBatchRemoveGroups()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.RemoveGroupsBatchInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput>> augmentationType)
Remove an augmentation from this builder's product.RemoveGroupsBatchInputBuilder
setBarrierAfter(Boolean value)
Set the property corresponding toBarrierSuffix.getBarrierAfter()
to the specified value.RemoveGroupsBatchInputBuilder
setBatchRemoveGroups(Map<BatchRemoveGroupsKey,BatchRemoveGroups> values)
Set the property corresponding toRemoveGroupsBatchInput.getBatchRemoveGroups()
to the specified value.RemoveGroupsBatchInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.
-
-
-
Constructor Detail
-
RemoveGroupsBatchInputBuilder
public RemoveGroupsBatchInputBuilder()
Construct an empty builder.
-
RemoveGroupsBatchInputBuilder
public RemoveGroupsBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
RemoveGroupsBatchInputBuilder
public RemoveGroupsBatchInputBuilder(BarrierSuffix arg)
Construct a new builder initialized from specifiedBarrierSuffix
.- Parameters:
arg
- BarrierSuffix from which the builder should be initialized
-
RemoveGroupsBatchInputBuilder
public RemoveGroupsBatchInputBuilder(RemoveGroupsBatchInput base)
Construct a builder initialized with state from specifiedRemoveGroupsBatchInput
.- Parameters:
base
- RemoveGroupsBatchInput 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
-
getBarrierAfter
public Boolean getBarrierAfter()
Return current value associated with the property corresponding toBarrierSuffix.getBarrierAfter()
.- Returns:
- current value
-
getBatchRemoveGroups
public Map<BatchRemoveGroupsKey,BatchRemoveGroups> getBatchRemoveGroups()
Return current value associated with the property corresponding toRemoveGroupsBatchInput.getBatchRemoveGroups()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput>> 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
-
setBarrierAfter
public RemoveGroupsBatchInputBuilder setBarrierAfter(Boolean value)
Set the property corresponding toBarrierSuffix.getBarrierAfter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBatchRemoveGroups
public RemoveGroupsBatchInputBuilder setBatchRemoveGroups(Map<BatchRemoveGroupsKey,BatchRemoveGroups> values)
Set the property corresponding toRemoveGroupsBatchInput.getBatchRemoveGroups()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setNode
public RemoveGroupsBatchInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RemoveGroupsBatchInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput> 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 RemoveGroupsBatchInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveGroupsBatchInput>> 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 RemoveGroupsBatchInput build()
A newRemoveGroupsBatchInput
instance.- Returns:
- A new
RemoveGroupsBatchInput
instance.
-
-