Class UpdateGroupOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpdateGroupOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpdateGroupOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UpdateGroupOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpdateGroupOutput>
Class that buildsUpdateGroupOutput
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:
UpdateGroupOutput createUpdateGroupOutput(int fooXyzzy, int barBaz) { return new UpdateGroupOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateGroupOutput, 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:
UpdateGroupOutput
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpdateGroupOutputBuilder()
UpdateGroupOutputBuilder(TransactionAware arg)
UpdateGroupOutputBuilder(UpdateGroupOutput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateGroupOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput>>
E$$augmentation(Class<E$$> augmentationType)
UpdateGroupOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.TransactionId
getTransactionId()
UpdateGroupOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput>> augmentationType)
Remove an augmentation from this builder's product.UpdateGroupOutputBuilder
setTransactionId(TransactionId value)
-
-
-
Constructor Detail
-
UpdateGroupOutputBuilder
public UpdateGroupOutputBuilder()
-
UpdateGroupOutputBuilder
public UpdateGroupOutputBuilder(TransactionAware arg)
-
UpdateGroupOutputBuilder
public UpdateGroupOutputBuilder(UpdateGroupOutput 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:- TransactionAware
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getTransactionId
public TransactionId getTransactionId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setTransactionId
public UpdateGroupOutputBuilder setTransactionId(TransactionId value)
-
addAugmentation
public UpdateGroupOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput> 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 UpdateGroupOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateGroupOutput>> 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 UpdateGroupOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpdateGroupOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpdateGroupOutput,IllegalArgumentException>
-
-