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

Class BasicFastRerouteObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.fast.reroute.object.fast.reroute.object.basic.fast.reroute.object._case.BasicFastRerouteObjectBuilder

All Implemented Interfaces:

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

public class BasicFastRerouteObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BasicFastRerouteObject>

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

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

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

BasicFastRerouteObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BasicFastRerouteObjectBuilder()
BasicFastRerouteObjectBuilder(AttributeFilters arg)
BasicFastRerouteObjectBuilder(BasicFastRerouteObject base)
BasicFastRerouteObjectBuilder(CommonFastRerouteObject arg)
BasicFastRerouteObjectBuilder(Priority arg)
BasicFastRerouteObjectBuilder(RsvpTeObject arg)

Method Summary

Modifier and Type	Method and Description
BasicFastRerouteObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> E$$	augmentation(Class<E$$> augmentationType)
BasicFastRerouteObject	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()
AttributeFilter	getExcludeAny()
FastRerouteFlags	getFlags()
Short	getHoldPriority()
Short	getHopLimit()
AttributeFilter	getIncludeAll()
AttributeFilter	getIncludeAny()
Short	getSetupPriority()
BasicFastRerouteObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> augmentationType)
BasicFastRerouteObjectBuilder	setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)
BasicFastRerouteObjectBuilder	setExcludeAny(AttributeFilter value)
BasicFastRerouteObjectBuilder	setFlags(FastRerouteFlags value)
BasicFastRerouteObjectBuilder	setHoldPriority(Short value)
BasicFastRerouteObjectBuilder	setHopLimit(Short value)
BasicFastRerouteObjectBuilder	setIncludeAll(AttributeFilter value)
BasicFastRerouteObjectBuilder	setIncludeAny(AttributeFilter value)
BasicFastRerouteObjectBuilder	setSetupPriority(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder()

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder(CommonFastRerouteObject arg)

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder(Priority arg)

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder(AttributeFilters arg)

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder(RsvpTeObject arg)

BasicFastRerouteObjectBuilder

public BasicFastRerouteObjectBuilder(BasicFastRerouteObject 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.CommonFastRerouteObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Priority
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters
• 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()

getExcludeAny

public AttributeFilter getExcludeAny()

getFlags

public FastRerouteFlags getFlags()

getHoldPriority

public Short getHoldPriority()

getHopLimit

public Short getHopLimit()

getIncludeAll

public AttributeFilter getIncludeAll()

getIncludeAny

public AttributeFilter getIncludeAny()

getSetupPriority

public Short getSetupPriority()

augmentation

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

setBandwidth

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

setExcludeAny

public BasicFastRerouteObjectBuilder setExcludeAny(AttributeFilter value)

setFlags

public BasicFastRerouteObjectBuilder setFlags(FastRerouteFlags value)

setHoldPriority

public BasicFastRerouteObjectBuilder setHoldPriority(Short value)

setHopLimit

public BasicFastRerouteObjectBuilder setHopLimit(Short value)

setIncludeAll

public BasicFastRerouteObjectBuilder setIncludeAll(AttributeFilter value)

setIncludeAny

public BasicFastRerouteObjectBuilder setIncludeAny(AttributeFilter value)

setSetupPriority

public BasicFastRerouteObjectBuilder setSetupPriority(Short value)

addAugmentation

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

removeAugmentation

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

build

public BasicFastRerouteObject build()

Specified by:

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