org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type.path.key._case

Class PathKeyBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type.path.key._case.PathKeyBuilder

All Implemented Interfaces:

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

public class PathKeyBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PathKey>

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

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

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

PathKeyBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PathKeyBuilder()
PathKeyBuilder(CSubobject arg)
PathKeyBuilder(PathKey base)
PathKeyBuilder(PathKeySubobject arg)

Method Summary

Modifier and Type	Method and Description
PathKeyBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PathKey> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> E$$	augmentation(Class<E$$> augmentationType)
PathKey	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
PathKey	getPathKey()
PceId	getPceId()
PathKeyBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> augmentationType)
PathKeyBuilder	setPathKey(PathKey value)
PathKeyBuilder	setPceId(PceId value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathKeyBuilder

public PathKeyBuilder()

PathKeyBuilder

public PathKeyBuilder(PathKeySubobject arg)

PathKeyBuilder

public PathKeyBuilder(CSubobject arg)

PathKeyBuilder

public PathKeyBuilder(PathKey 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.PathKeySubobject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.CSubobject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPathKey

public PathKey getPathKey()

getPceId

public PceId getPceId()

augmentation

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

setPathKey

public PathKeyBuilder setPathKey(PathKey value)

setPceId

public PathKeyBuilder setPceId(PceId value)

addAugmentation

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

removeAugmentation

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

build

public PathKey build()

Specified by:

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