Package org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614

Class ImageInstallOutputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.ImageInstallOutputBuilder

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

Class that builds ImageInstallOutput 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:

   
     ImageInstallOutput createImageInstallOutput(int fooXyzzy, int barBaz) {
         return new ImageInstallOutputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of ImageInstallOutput, 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:

ImageInstallOutput

Constructor Summary

Constructors

Constructor	Description
ImageInstallOutputBuilder()	Construct an empty builder.
ImageInstallOutputBuilder(ImageInstallOutput base)	Construct a builder initialized with state from specified ImageInstallOutput.

Method Summary

Modifier and Type	Method	Description
ImageInstallOutputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull ImageInstallOutput	build()	A new ImageInstallOutput instance.
ImageInstallResponse	getImageInstallResponse()	Return current value associated with the property corresponding to ImageInstallOutput.getImageInstallResponse().
ImageInstallOutputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput>> augmentationType)	Remove an augmentation from this builder's product.
ImageInstallOutputBuilder	setImageInstallResponse(ImageInstallResponse value)	Set the property corresponding to ImageInstallOutput.getImageInstallResponse() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageInstallOutputBuilder

public ImageInstallOutputBuilder()

Construct an empty builder.

ImageInstallOutputBuilder

public ImageInstallOutputBuilder(ImageInstallOutput base)

Construct a builder initialized with state from specified ImageInstallOutput.

Parameters:

base - ImageInstallOutput from which the builder should be initialized

Method Detail

getImageInstallResponse

public ImageInstallResponse getImageInstallResponse()

Return current value associated with the property corresponding to ImageInstallOutput.getImageInstallResponse().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput>> 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

setImageInstallResponse

public ImageInstallOutputBuilder setImageInstallResponse(ImageInstallResponse value)

Set the property corresponding to ImageInstallOutput.getImageInstallResponse() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public ImageInstallOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput> 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 ImageInstallOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageInstallOutput>> 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 ImageInstallOutput build()

A new ImageInstallOutput instance.

Returns:

A new ImageInstallOutput instance.