Class UpdateGroupInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpdateGroupInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpdateGroupInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UpdateGroupInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpdateGroupInput>
Class that buildsUpdateGroupInput
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:
UpdateGroupInput createUpdateGroupInput(int fooXyzzy, int barBaz) { return new UpdateGroupInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateGroupInput, 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:
UpdateGroupInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpdateGroupInputBuilder()
UpdateGroupInputBuilder(TransactionMetadata arg)
UpdateGroupInputBuilder(GroupUpdate arg)
UpdateGroupInputBuilder(UpdateGroupInput base)
UpdateGroupInputBuilder(NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateGroupInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput>>
E$$augmentation(Class<E$$> augmentationType)
UpdateGroupInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.GroupRef
getGroupRef()
NodeRef
getNode()
OriginalGroup
getOriginalGroup()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
UpdatedGroup
getUpdatedGroup()
UpdateGroupInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput>> augmentationType)
Remove an augmentation from this builder's product.UpdateGroupInputBuilder
setGroupRef(GroupRef value)
UpdateGroupInputBuilder
setNode(NodeRef value)
UpdateGroupInputBuilder
setOriginalGroup(OriginalGroup value)
UpdateGroupInputBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
UpdateGroupInputBuilder
setUpdatedGroup(UpdatedGroup value)
-
-
-
Constructor Detail
-
UpdateGroupInputBuilder
public UpdateGroupInputBuilder()
-
UpdateGroupInputBuilder
public UpdateGroupInputBuilder(TransactionMetadata arg)
-
UpdateGroupInputBuilder
public UpdateGroupInputBuilder(GroupUpdate arg)
-
UpdateGroupInputBuilder
public UpdateGroupInputBuilder(NodeContextRef arg)
-
UpdateGroupInputBuilder
public UpdateGroupInputBuilder(UpdateGroupInput 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:- TransactionMetadata
- GroupUpdate
- NodeContextRef
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGroupRef
public GroupRef getGroupRef()
-
getNode
public NodeRef getNode()
-
getOriginalGroup
public OriginalGroup getOriginalGroup()
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
-
getUpdatedGroup
public UpdatedGroup getUpdatedGroup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setGroupRef
public UpdateGroupInputBuilder setGroupRef(GroupRef value)
-
setNode
public UpdateGroupInputBuilder setNode(NodeRef value)
-
setOriginalGroup
public UpdateGroupInputBuilder setOriginalGroup(OriginalGroup value)
-
setTransactionUri
public UpdateGroupInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
setUpdatedGroup
public UpdateGroupInputBuilder setUpdatedGroup(UpdatedGroup value)
-
addAugmentation
public UpdateGroupInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput> 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 UpdateGroupInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupInput>> 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 UpdateGroupInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpdateGroupInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpdateGroupInput,IllegalArgumentException>
-
-