org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type

Class BasicProtectionCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type.BasicProtectionCaseBuilder

All Implemented Interfaces:

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

public class BasicProtectionCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BasicProtectionCase>

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

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

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

BasicProtectionCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BasicProtectionCaseBuilder()
BasicProtectionCaseBuilder(BasicProtectionCase base)

Method Summary

Modifier and Type	Method and Description
BasicProtectionCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionCase>> E$$	augmentation(Class<E$$> augmentationType)
BasicProtectionCase	build()
BasicProtection	getBasicProtection()
BasicProtectionCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionCase>> augmentationType)
BasicProtectionCaseBuilder	setBasicProtection(BasicProtection value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProtectionCaseBuilder

public BasicProtectionCaseBuilder()

BasicProtectionCaseBuilder

public BasicProtectionCaseBuilder(BasicProtectionCase base)

Method Detail

getBasicProtection

public BasicProtection getBasicProtection()

augmentation

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

setBasicProtection

public BasicProtectionCaseBuilder setBasicProtection(BasicProtection value)

addAugmentation

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

removeAugmentation

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

build

public BasicProtectionCase build()

Specified by:

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