org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lspa.object

Class LspaBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lspa.object.LspaBuilder

All Implemented Interfaces:

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

public class LspaBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Lspa>

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

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

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

LspaBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
LspaBuilder()
LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters arg)
LspaBuilder(Lspa base)
LspaBuilder(Object arg)
LspaBuilder(ObjectHeader arg)
LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Priority arg)
LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.TunnelAttributes arg)

Method Summary

Modifier and Type	Method and Description
LspaBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lspa>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Lspa> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lspa>> E$$	augmentation(Class<E$$> augmentationType)
Lspa	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.rsvp.rev150820.AttributeFilter	getExcludeAny()
Short	getHoldPriority()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter	getIncludeAll()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter	getIncludeAny()
String	getSessionName()
Short	getSetupPriority()
Tlvs	getTlvs()
Boolean	isIgnore()
Boolean	isLabelRecordingDesired()
Boolean	isLocalProtectionDesired()
Boolean	isProcessingRule()
Boolean	isSeStyleDesired()
LspaBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lspa>> augmentationType)
LspaBuilder	setExcludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
LspaBuilder	setHoldPriority(Short value)
LspaBuilder	setIgnore(Boolean value)
LspaBuilder	setIncludeAll(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
LspaBuilder	setIncludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
LspaBuilder	setLabelRecordingDesired(Boolean value)
LspaBuilder	setLocalProtectionDesired(Boolean value)
LspaBuilder	setProcessingRule(Boolean value)
LspaBuilder	setSessionName(String value)
LspaBuilder	setSeStyleDesired(Boolean value)
LspaBuilder	setSetupPriority(Short value)
LspaBuilder	setTlvs(Tlvs value)

Methods inherited from class java.lang.Object

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

Constructor Detail

LspaBuilder

public LspaBuilder()

LspaBuilder

public LspaBuilder(Object arg)

LspaBuilder

public LspaBuilder(ObjectHeader arg)

LspaBuilder

public LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.TunnelAttributes arg)

LspaBuilder

public LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Priority arg)

LspaBuilder

public LspaBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters arg)

LspaBuilder

public LspaBuilder(Lspa 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.pcep.types.rev181109.ObjectHeader
• 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.TunnelAttributes
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getExcludeAny

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getExcludeAny()

getHoldPriority

public Short getHoldPriority()

getIncludeAll

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAll()

getIncludeAny

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAny()

getSessionName

public String getSessionName()

getSetupPriority

public Short getSetupPriority()

getTlvs

public Tlvs getTlvs()

isIgnore

public Boolean isIgnore()

isLabelRecordingDesired

public Boolean isLabelRecordingDesired()

isLocalProtectionDesired

public Boolean isLocalProtectionDesired()

isProcessingRule

public Boolean isProcessingRule()

isSeStyleDesired

public Boolean isSeStyleDesired()

augmentation

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

setExcludeAny

public LspaBuilder setExcludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

setHoldPriority

public LspaBuilder setHoldPriority(Short value)

setIncludeAll

public LspaBuilder setIncludeAll(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

setIncludeAny

public LspaBuilder setIncludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

setSessionName

public LspaBuilder setSessionName(String value)

setSetupPriority

public LspaBuilder setSetupPriority(Short value)

setTlvs

public LspaBuilder setTlvs(Tlvs value)

setIgnore

public LspaBuilder setIgnore(Boolean value)

setLabelRecordingDesired

public LspaBuilder setLabelRecordingDesired(Boolean value)

setLocalProtectionDesired

public LspaBuilder setLocalProtectionDesired(Boolean value)

setProcessingRule

public LspaBuilder setProcessingRule(Boolean value)

setSeStyleDesired

public LspaBuilder setSeStyleDesired(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Lspa build()

Specified by:

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