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

Class BasicBandwidthObjectBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class BasicBandwidthObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BasicBandwidthObject>

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

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

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

BasicBandwidthObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BasicBandwidthObjectBuilder()
BasicBandwidthObjectBuilder(BasicBandwidthObject base)
BasicBandwidthObjectBuilder(RsvpTeObject arg)

Method Summary

Modifier and Type	Method and Description
BasicBandwidthObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObject>> E$$	augmentation(Class<E$$> augmentationType)
BasicBandwidthObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth	getBandwidth()
BasicBandwidthObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicBandwidthObject>> augmentationType)
BasicBandwidthObjectBuilder	setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicBandwidthObjectBuilder

public BasicBandwidthObjectBuilder()

BasicBandwidthObjectBuilder

public BasicBandwidthObjectBuilder(RsvpTeObject arg)

BasicBandwidthObjectBuilder

public BasicBandwidthObjectBuilder(BasicBandwidthObject base)

Method Detail

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RsvpTeObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getBandwidth

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth getBandwidth()

augmentation

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

setBandwidth

public BasicBandwidthObjectBuilder setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)

addAugmentation

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

removeAugmentation

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

build

public BasicBandwidthObject build()

Specified by:

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