Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109
Class SubmitTriggerSyncOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109.SubmitTriggerSyncOutputBuilder
-
@Generated("mdsal-binding-generator") public class SubmitTriggerSyncOutputBuilder extends Object
Class that buildsSubmitTriggerSyncOutput
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:
SubmitTriggerSyncOutput createSubmitTriggerSyncOutput(int fooXyzzy, int barBaz) { return new SubmitTriggerSyncOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubmitTriggerSyncOutput, 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:
SubmitTriggerSyncOutput
- 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 SubmitTriggerSyncOutputBuilder()
Construct an empty builder.SubmitTriggerSyncOutputBuilder(SubmitInstructionOutput arg)
Construct a new builder initialized from specifiedSubmitInstructionOutput
.SubmitTriggerSyncOutputBuilder(SubmitTriggerSyncOutput base)
Construct a builder initialized with state from specifiedSubmitTriggerSyncOutput
.SubmitTriggerSyncOutputBuilder(TopologyInstructionOutput arg)
Construct a new builder initialized from specifiedTopologyInstructionOutput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubmitTriggerSyncOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SubmitTriggerSyncOutput
build()
A newSubmitTriggerSyncOutput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Result
getResult()
Return current value associated with the property corresponding toSubmitInstructionOutput.getResult()
.SubmitTriggerSyncOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput>> augmentationType)
Remove an augmentation from this builder's product.SubmitTriggerSyncOutputBuilder
setResult(Result value)
Set the property corresponding toSubmitInstructionOutput.getResult()
to the specified value.
-
-
-
Constructor Detail
-
SubmitTriggerSyncOutputBuilder
public SubmitTriggerSyncOutputBuilder()
Construct an empty builder.
-
SubmitTriggerSyncOutputBuilder
public SubmitTriggerSyncOutputBuilder(TopologyInstructionOutput arg)
Construct a new builder initialized from specifiedTopologyInstructionOutput
.- Parameters:
arg
- TopologyInstructionOutput from which the builder should be initialized
-
SubmitTriggerSyncOutputBuilder
public SubmitTriggerSyncOutputBuilder(SubmitInstructionOutput arg)
Construct a new builder initialized from specifiedSubmitInstructionOutput
.- Parameters:
arg
- SubmitInstructionOutput from which the builder should be initialized
-
SubmitTriggerSyncOutputBuilder
public SubmitTriggerSyncOutputBuilder(SubmitTriggerSyncOutput base)
Construct a builder initialized with state from specifiedSubmitTriggerSyncOutput
.- Parameters:
base
- SubmitTriggerSyncOutput 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
-
getResult
public Result getResult()
Return current value associated with the property corresponding toSubmitInstructionOutput.getResult()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput>> 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
-
setResult
public SubmitTriggerSyncOutputBuilder setResult(Result value)
Set the property corresponding toSubmitInstructionOutput.getResult()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SubmitTriggerSyncOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput> 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 SubmitTriggerSyncOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitTriggerSyncOutput>> 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 SubmitTriggerSyncOutput build()
A newSubmitTriggerSyncOutput
instance.- Returns:
- A new
SubmitTriggerSyncOutput
instance.
-
-