org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result

Class SuccessCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.SuccessCaseBuilder

All Implemented Interfaces:

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

public class SuccessCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SuccessCase>

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

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

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

SuccessCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SuccessCaseBuilder()
SuccessCaseBuilder(SuccessCase base)

Method Summary

Modifier and Type	Method and Description
SuccessCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SuccessCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SuccessCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SuccessCase>> E$$	augmentation(Class<E$$> augmentationType)
SuccessCase	build()
Success	getSuccess()
SuccessCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SuccessCase>> augmentationType)
SuccessCaseBuilder	setSuccess(Success value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuccessCaseBuilder

public SuccessCaseBuilder()

SuccessCaseBuilder

public SuccessCaseBuilder(SuccessCase base)

Method Detail

getSuccess

public Success getSuccess()

augmentation

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

setSuccess

public SuccessCaseBuilder setSuccess(Success value)

addAugmentation

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

removeAugmentation

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

build

public SuccessCase build()

Specified by:

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