org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.object.protection.object

Class BasicProtectionObjectCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.object.protection.object.BasicProtectionObjectCaseBuilder

All Implemented Interfaces:

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

public class BasicProtectionObjectCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BasicProtectionObjectCase>

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

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

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

BasicProtectionObjectCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BasicProtectionObjectCaseBuilder()
BasicProtectionObjectCaseBuilder(BasicProtectionObjectCase base)

Method Summary

Modifier and Type	Method and Description
BasicProtectionObjectCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObjectCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObjectCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObjectCase>> E$$	augmentation(Class<E$$> augmentationType)
BasicProtectionObjectCase	build()
BasicProtectionObject	getBasicProtectionObject()
BasicProtectionObjectCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObjectCase>> augmentationType)
BasicProtectionObjectCaseBuilder	setBasicProtectionObject(BasicProtectionObject value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProtectionObjectCaseBuilder

public BasicProtectionObjectCaseBuilder()

BasicProtectionObjectCaseBuilder

public BasicProtectionObjectCaseBuilder(BasicProtectionObjectCase base)

Method Detail

getBasicProtectionObject

public BasicProtectionObject getBasicProtectionObject()

augmentation

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

setBasicProtectionObject

public BasicProtectionObjectCaseBuilder setBasicProtectionObject(BasicProtectionObject value)

addAugmentation

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

removeAugmentation

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

build

public BasicProtectionObjectCase build()

Specified by:

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