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

Class TspecObjectBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class TspecObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<TspecObject>

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

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

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

TspecObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
TspecObjectBuilder()
TspecObjectBuilder(RsvpTeObject arg)
TspecObjectBuilder(TspecObject base)

Method Summary

Modifier and Type	Method and Description
TspecObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> E$$	augmentation(Class<E$$> augmentationType)
TspecObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Long	getMaximumPacketSize()
Long	getMinimumPolicedUnit()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32	getPeakDataRate()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32	getTokenBucketRate()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32	getTokenBucketSize()
TspecObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> augmentationType)
TspecObjectBuilder	setMaximumPacketSize(Long value)
TspecObjectBuilder	setMinimumPolicedUnit(Long value)
TspecObjectBuilder	setPeakDataRate(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)
TspecObjectBuilder	setTokenBucketRate(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)
TspecObjectBuilder	setTokenBucketSize(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

TspecObjectBuilder

public TspecObjectBuilder()

TspecObjectBuilder

public TspecObjectBuilder(RsvpTeObject arg)

TspecObjectBuilder

public TspecObjectBuilder(TspecObject 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

getMaximumPacketSize

public Long getMaximumPacketSize()

getMinimumPolicedUnit

public Long getMinimumPolicedUnit()

getPeakDataRate

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 getPeakDataRate()

getTokenBucketRate

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 getTokenBucketRate()

getTokenBucketSize

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 getTokenBucketSize()

augmentation

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

setMaximumPacketSize

public TspecObjectBuilder setMaximumPacketSize(Long value)

setMinimumPolicedUnit

public TspecObjectBuilder setMinimumPolicedUnit(Long value)

setPeakDataRate

public TspecObjectBuilder setPeakDataRate(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

setTokenBucketRate

public TspecObjectBuilder setTokenBucketRate(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

setTokenBucketSize

public TspecObjectBuilder setTokenBucketSize(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

addAugmentation

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

removeAugmentation

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

build

public TspecObject build()

Specified by:

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