org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.setup.type.tlv

Class PathSetupTypeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.setup.type.tlv.PathSetupTypeBuilder

All Implemented Interfaces:

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

public class PathSetupTypeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PathSetupType>

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

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

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

PathSetupTypeBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PathSetupTypeBuilder()
PathSetupTypeBuilder(PathSetupType base)
PathSetupTypeBuilder(Tlv arg)

Method Summary

Modifier and Type	Method and Description
PathSetupTypeBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathSetupType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PathSetupType> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathSetupType>> E$$	augmentation(Class<E$$> augmentationType)
PathSetupType	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Short	getPst()
PathSetupTypeBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathSetupType>> augmentationType)
PathSetupTypeBuilder	setPst(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathSetupTypeBuilder

public PathSetupTypeBuilder()

PathSetupTypeBuilder

public PathSetupTypeBuilder(Tlv arg)

PathSetupTypeBuilder

public PathSetupTypeBuilder(PathSetupType 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.Tlv

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPst

public Short getPst()

augmentation

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

setPst

public PathSetupTypeBuilder setPst(Short value)

addAugmentation

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

removeAugmentation

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

build

public PathSetupType build()

Specified by:

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