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