org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.config.rev171025.pcep.node.config

Class SessionConfigBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.config.rev171025.pcep.node.config.SessionConfigBuilder

All Implemented Interfaces:

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

public class SessionConfigBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SessionConfig>

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

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

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

SessionConfigBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SessionConfigBuilder()
SessionConfigBuilder(SessionConfig base)

Method Summary

Modifier and Type	Method and Description
SessionConfigBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> E$$	augmentation(Class<E$$> augmentationType)
SessionConfig	build()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key	getPassword()
SessionConfigBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType)
SessionConfigBuilder	setPassword(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionConfigBuilder

public SessionConfigBuilder()

SessionConfigBuilder

public SessionConfigBuilder(SessionConfig base)

Method Detail

getPassword

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key getPassword()

augmentation

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

setPassword

public SessionConfigBuilder setPassword(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key value)

addAugmentation

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

removeAugmentation

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

build

public SessionConfig build()

Specified by:

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