org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.user.error.spec

Class SubobjectsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.user.error.spec.SubobjectsBuilder

All Implemented Interfaces:

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

public class SubobjectsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Subobjects>

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

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

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

SubobjectsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SubobjectsBuilder()
SubobjectsBuilder(Subobjects base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SubobjectsBuilder

public SubobjectsBuilder()

SubobjectsBuilder

public SubobjectsBuilder(Subobjects base)

Method Detail

augmentation

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

addAugmentation

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

removeAugmentation

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

build

public Subobjects build()

Specified by:

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