org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120

Class CancelToastInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.CancelToastInputBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<CancelToastInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<CancelToastInput,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class CancelToastInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<CancelToastInput>

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

   
     CancelToastInputBuilder createTarget(int fooXyzzy, int barBaz) {
         return new CancelToastInputBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

CancelToastInputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
CancelToastInputBuilder()
CancelToastInputBuilder(CancelToastInput base)

Method Summary

Modifier and Type	Method and Description
CancelToastInputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> E$$	augmentation(Class<E$$> augmentationType)
CancelToastInput	build()
CancelToastInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> augmentationType)

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelToastInputBuilder

public CancelToastInputBuilder()

CancelToastInputBuilder

public CancelToastInputBuilder(CancelToastInput base)

Method Detail

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> E$$ augmentation(Class<E$$> augmentationType)

addAugmentation

public CancelToastInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> augmentationType,
                                               org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput> augmentationValue)

removeAugmentation

public CancelToastInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CancelToastInput>> augmentationType)

build

public CancelToastInput build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<CancelToastInput,IllegalArgumentException>