Class AddGroupInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddGroupInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddGroupInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AddGroupInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AddGroupInput>
Class that buildsAddGroupInputBuilder
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:
AddGroupInputBuilder createTarget(int fooXyzzy, int barBaz) { return new AddGroupInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddGroupInputBuilder, 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:
AddGroupInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddGroupInputBuilder()
AddGroupInputBuilder(TransactionMetadata arg)
AddGroupInputBuilder(AddGroupInput base)
AddGroupInputBuilder(NodeGroup arg)
AddGroupInputBuilder(Group arg)
AddGroupInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AddGroupInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput>>
E$$augmentation(Class<E$$> augmentationType)
AddGroupInput
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()
GroupRef
getGroupRef()
GroupTypes
getGroupType()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
Boolean
isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.AddGroupInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput>> augmentationType)
Remove an augmentation from this builder's product.AddGroupInputBuilder
setBarrier(Boolean value)
AddGroupInputBuilder
setBuckets(Buckets value)
AddGroupInputBuilder
setContainerName(String value)
AddGroupInputBuilder
setGroupId(GroupId value)
AddGroupInputBuilder
setGroupName(String value)
AddGroupInputBuilder
setGroupRef(GroupRef value)
AddGroupInputBuilder
setGroupType(GroupTypes value)
AddGroupInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
AddGroupInputBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
-
-
Constructor Detail
-
AddGroupInputBuilder
public AddGroupInputBuilder()
-
AddGroupInputBuilder
public AddGroupInputBuilder(TransactionMetadata arg)
-
AddGroupInputBuilder
public AddGroupInputBuilder(NodeGroup arg)
-
AddGroupInputBuilder
public AddGroupInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
AddGroupInputBuilder
public AddGroupInputBuilder(Group arg)
-
AddGroupInputBuilder
public AddGroupInputBuilder(AddGroupInput 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
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionMetadata
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.NodeGroup
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
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()
-
getGroupRef
public GroupRef getGroupRef()
-
getGroupType
public GroupTypes getGroupType()
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public AddGroupInputBuilder setBarrier(Boolean value)
-
setBuckets
public AddGroupInputBuilder setBuckets(Buckets value)
-
setContainerName
public AddGroupInputBuilder setContainerName(String value)
-
setGroupId
public AddGroupInputBuilder setGroupId(GroupId value)
-
setGroupName
public AddGroupInputBuilder setGroupName(String value)
-
setGroupRef
public AddGroupInputBuilder setGroupRef(GroupRef value)
-
setGroupType
public AddGroupInputBuilder setGroupType(GroupTypes value)
-
setNode
public AddGroupInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setTransactionUri
public AddGroupInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
addAugmentation
public AddGroupInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput> 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 AddGroupInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddGroupInput>> 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 AddGroupInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddGroupInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddGroupInput,IllegalArgumentException>
-
-