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

Class BasicBandwidthObjectCaseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class BasicBandwidthObjectCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BasicBandwidthObjectCase>

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

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

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

BasicBandwidthObjectCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BasicBandwidthObjectCaseBuilder()
BasicBandwidthObjectCaseBuilder(BasicBandwidthObjectCase base)

Method Summary

Modifier and Type	Method and Description
BasicBandwidthObjectCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObjectCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObjectCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObjectCase>> E$$	augmentation(Class<E$$> augmentationType)
BasicBandwidthObjectCase	build()
BasicBandwidthObject	getBasicBandwidthObject()
BasicBandwidthObjectCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObjectCase>> augmentationType)
BasicBandwidthObjectCaseBuilder	setBasicBandwidthObject(BasicBandwidthObject value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicBandwidthObjectCaseBuilder

public BasicBandwidthObjectCaseBuilder()

BasicBandwidthObjectCaseBuilder

public BasicBandwidthObjectCaseBuilder(BasicBandwidthObjectCase base)

Method Detail

getBasicBandwidthObject

public BasicBandwidthObject getBasicBandwidthObject()

augmentation

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

setBasicBandwidthObject

public BasicBandwidthObjectCaseBuilder setBasicBandwidthObject(BasicBandwidthObject value)

addAugmentation

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

removeAugmentation

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

build

public BasicBandwidthObjectCase build()

Specified by:

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