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

Class PathKeyCaseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PathKeyCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PathKeyCase>

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

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

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

PathKeyCaseBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
PathKeyCaseBuilder()
PathKeyCaseBuilder(PathKeyCase base)

Method Summary

Modifier and Type	Method	Description
PathKeyCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> E$$	augmentation(Class<E$$> augmentationType)
PathKeyCase	build()
PathKey	getPathKey()
PathKeyCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> augmentationType)
PathKeyCaseBuilder	setPathKey(PathKey value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathKeyCaseBuilder

public PathKeyCaseBuilder()

PathKeyCaseBuilder

public PathKeyCaseBuilder(PathKeyCase base)

Method Detail

getPathKey

public PathKey getPathKey()

augmentation

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

setPathKey

public PathKeyCaseBuilder setPathKey(PathKey value)

addAugmentation

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

removeAugmentation

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

build

public PathKeyCase build()

Specified by:

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

Specified by:

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