Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object

Class LspBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.LspBuilder

All Implemented Interfaces:

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

public class LspBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Lsp>

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

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

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

LspBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
LspBuilder()
LspBuilder(Lsp base)
LspBuilder(Object arg)
LspBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method	Description
LspBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Lsp> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> E$$	augmentation(Class<E$$> augmentationType)
Lsp	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
OperationalStatus	getOperational()
PlspId	getPlspId()
Tlvs	getTlvs()
Boolean	isAdministrative()
Boolean	isDelegate()
Boolean	isIgnore()
Boolean	isProcessingRule()
Boolean	isRemove()
Boolean	isSync()
LspBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> augmentationType)
LspBuilder	setAdministrative(Boolean value)
LspBuilder	setDelegate(Boolean value)
LspBuilder	setIgnore(Boolean value)
LspBuilder	setOperational(OperationalStatus value)
LspBuilder	setPlspId(PlspId value)
LspBuilder	setProcessingRule(Boolean value)
LspBuilder	setRemove(Boolean value)
LspBuilder	setSync(Boolean value)
LspBuilder	setTlvs(Tlvs value)

Methods inherited from class java.lang.Object

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

Constructor Detail

LspBuilder

public LspBuilder()

LspBuilder

public LspBuilder(Object arg)

LspBuilder

public LspBuilder(ObjectHeader arg)

LspBuilder

public LspBuilder(Lsp 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.pcep.types.rev181109.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getOperational

public OperationalStatus getOperational()

getPlspId

public PlspId getPlspId()

getTlvs

public Tlvs getTlvs()

isAdministrative

public Boolean isAdministrative()

isDelegate

public Boolean isDelegate()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

isRemove

public Boolean isRemove()

isSync

public Boolean isSync()

augmentation

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

setOperational

public LspBuilder setOperational(OperationalStatus value)

setPlspId

public LspBuilder setPlspId(PlspId value)

setTlvs

public LspBuilder setTlvs(Tlvs value)

setAdministrative

public LspBuilder setAdministrative(Boolean value)

setDelegate

public LspBuilder setDelegate(Boolean value)

setIgnore

public LspBuilder setIgnore(Boolean value)

setProcessingRule

public LspBuilder setProcessingRule(Boolean value)

setRemove

public LspBuilder setRemove(Boolean value)

setSync

public LspBuilder setSync(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Lsp build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Lsp>

Specified by:

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