Class TriggerSyncOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TriggerSyncOutputBuilder
-
@Generated("mdsal-binding-generator") public class TriggerSyncOutputBuilder extends Object
Class that buildsTriggerSyncOutput
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:
TriggerSyncOutput createTriggerSyncOutput(int fooXyzzy, int barBaz) { return new TriggerSyncOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TriggerSyncOutput, 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:
TriggerSyncOutput
- 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 TriggerSyncOutputBuilder()
Construct an empty builder.TriggerSyncOutputBuilder(OperationResult arg)
Construct a new builder initialized from specifiedOperationResult
.TriggerSyncOutputBuilder(TriggerSyncOutput base)
Construct a builder initialized with state from specifiedTriggerSyncOutput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TriggerSyncOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TriggerSyncOutput
build()
A newTriggerSyncOutput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Error>
getError()
Return current value associated with the property corresponding toOperationResult.getError()
.FailureType
getFailure()
Return current value associated with the property corresponding toOperationResult.getFailure()
.TriggerSyncOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput>> augmentationType)
Remove an augmentation from this builder's product.TriggerSyncOutputBuilder
setError(List<Error> values)
Set the property corresponding toOperationResult.getError()
to the specified value.TriggerSyncOutputBuilder
setFailure(FailureType value)
Set the property corresponding toOperationResult.getFailure()
to the specified value.
-
-
-
Constructor Detail
-
TriggerSyncOutputBuilder
public TriggerSyncOutputBuilder()
Construct an empty builder.
-
TriggerSyncOutputBuilder
public TriggerSyncOutputBuilder(OperationResult arg)
Construct a new builder initialized from specifiedOperationResult
.- Parameters:
arg
- OperationResult from which the builder should be initialized
-
TriggerSyncOutputBuilder
public TriggerSyncOutputBuilder(TriggerSyncOutput base)
Construct a builder initialized with state from specifiedTriggerSyncOutput
.- Parameters:
base
- TriggerSyncOutput 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
-
getError
public List<Error> getError()
Return current value associated with the property corresponding toOperationResult.getError()
.- Returns:
- current value
-
getFailure
public FailureType getFailure()
Return current value associated with the property corresponding toOperationResult.getFailure()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput>> 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
-
setError
public TriggerSyncOutputBuilder setError(List<Error> values)
Set the property corresponding toOperationResult.getError()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setFailure
public TriggerSyncOutputBuilder setFailure(FailureType value)
Set the property corresponding toOperationResult.getFailure()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TriggerSyncOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput> 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 TriggerSyncOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TriggerSyncOutput>> 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 TriggerSyncOutput build()
A newTriggerSyncOutput
instance.- Returns:
- A new
TriggerSyncOutput
instance.
-
-