Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730

Class EnsureLspOperationalOutputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.EnsureLspOperationalOutputBuilder

@Generated("mdsal-binding-generator")
public class EnsureLspOperationalOutputBuilder
extends Object

Class that builds EnsureLspOperationalOutput 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

Constructor Summary

Constructors

Constructor	Description
EnsureLspOperationalOutputBuilder()	Construct an empty builder.
EnsureLspOperationalOutputBuilder(EnsureLspOperationalOutput base)	Construct a builder initialized with state from specified EnsureLspOperationalOutput.
EnsureLspOperationalOutputBuilder(OperationResult arg)	Construct a new builder initialized from specified OperationResult.

Method Summary

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)	Return the specified augmentation, if it is present in this builder.
@NonNull EnsureLspOperationalOutput	build()	A new EnsureLspOperationalOutput 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 to OperationResult.getError().
FailureType	getFailure()	Return current value associated with the property corresponding to OperationResult.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)	Set the property corresponding to OperationResult.getError() to the specified value.
EnsureLspOperationalOutputBuilder	setFailure(FailureType value)	Set the property corresponding to OperationResult.getFailure() to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnsureLspOperationalOutputBuilder

public EnsureLspOperationalOutputBuilder()

Construct an empty builder.

EnsureLspOperationalOutputBuilder

public EnsureLspOperationalOutputBuilder(OperationResult arg)

Construct a new builder initialized from specified OperationResult.

Parameters:

arg - OperationResult from which the builder should be initialized

EnsureLspOperationalOutputBuilder

public EnsureLspOperationalOutputBuilder(EnsureLspOperationalOutput base)

Construct a builder initialized with state from specified EnsureLspOperationalOutput.

Parameters:

base - EnsureLspOperationalOutput from which the builder should be initialized

Method Details

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

getError

public List<Error> getError()

Return current value associated with the property corresponding to OperationResult.getError().

Returns:

current value

getFailure

public FailureType getFailure()

Return current value associated with the property corresponding to OperationResult.getFailure().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EnsureLspOperationalOutput>>
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 - if augmentType is null

setError

public EnsureLspOperationalOutputBuilder setError(List<Error> values)

Set the property corresponding to OperationResult.getError() to the specified value.

Parameters:

values - desired value

Returns:

this builder

setFailure

public EnsureLspOperationalOutputBuilder setFailure(FailureType value)

Set the property corresponding to OperationResult.getFailure() to the specified value.

Parameters:

value - desired value

Returns:

this builder

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 - if augmentation 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 @NonNull EnsureLspOperationalOutput build()

A new EnsureLspOperationalOutput instance.

Returns:

A new EnsureLspOperationalOutput instance.