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

Class FlowSpecObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.flow.spec.object.FlowSpecObjectBuilder

All Implemented Interfaces:

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

public class FlowSpecObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowSpecObject>

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

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

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

FlowSpecObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowSpecObjectBuilder()
FlowSpecObjectBuilder(FlowSpecObject base)
FlowSpecObjectBuilder(RsvpTeObject arg)
FlowSpecObjectBuilder(TspecObject arg)

Method Summary

Modifier and Type	Method and Description
FlowSpecObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> E$$	augmentation(Class<E$$> augmentationType)
FlowSpecObject	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.ieee754.rev130819.Float32	getRate()
ServiceNumber	getServiceHeader()
Long	getSlackTerm()
TspecObject	getTspecObject()
FlowSpecObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> augmentationType)
FlowSpecObjectBuilder	setRate(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)
FlowSpecObjectBuilder	setServiceHeader(ServiceNumber value)
FlowSpecObjectBuilder	setSlackTerm(Long value)
FlowSpecObjectBuilder	setTspecObject(TspecObject value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowSpecObjectBuilder

public FlowSpecObjectBuilder()

FlowSpecObjectBuilder

public FlowSpecObjectBuilder(RsvpTeObject arg)

FlowSpecObjectBuilder

public FlowSpecObjectBuilder(TspecObject arg)

FlowSpecObjectBuilder

public FlowSpecObjectBuilder(FlowSpecObject 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.TspecObject
• 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

getRate

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

getServiceHeader

public ServiceNumber getServiceHeader()

getSlackTerm

public Long getSlackTerm()

getTspecObject

public TspecObject getTspecObject()

augmentation

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

setRate

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

setServiceHeader

public FlowSpecObjectBuilder setServiceHeader(ServiceNumber value)

setSlackTerm

public FlowSpecObjectBuilder setSlackTerm(Long value)

setTspecObject

public FlowSpecObjectBuilder setTspecObject(TspecObject value)

addAugmentation

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

removeAugmentation

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

build

public FlowSpecObject build()

Specified by:

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