org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.arbitrator.reconcile.service.rev180227

Class CommitActiveBundleOutputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.arbitrator.reconcile.service.rev180227.CommitActiveBundleOutputBuilder

All Implemented Interfaces:

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

public class CommitActiveBundleOutputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<CommitActiveBundleOutput>

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

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

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

CommitActiveBundleOutputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
CommitActiveBundleOutputBuilder()
CommitActiveBundleOutputBuilder(CommitActiveBundleOutput base)

Method Summary

Modifier and Type	Method and Description
CommitActiveBundleOutputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleOutput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleOutput>> E$$	augmentation(Class<E$$> augmentationType)
CommitActiveBundleOutput	build()
Boolean	isResult()
CommitActiveBundleOutputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CommitActiveBundleOutput>> augmentationType)
CommitActiveBundleOutputBuilder	setResult(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitActiveBundleOutputBuilder

public CommitActiveBundleOutputBuilder()

CommitActiveBundleOutputBuilder

public CommitActiveBundleOutputBuilder(CommitActiveBundleOutput base)

Method Detail

isResult

public Boolean isResult()

augmentation

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

setResult

public CommitActiveBundleOutputBuilder setResult(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public CommitActiveBundleOutput build()

Specified by:

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