org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.session._case

Class SessionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.session._case.SessionBuilder

All Implemented Interfaces:

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

public class SessionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Session>

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

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

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

SessionBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SessionBuilder()
SessionBuilder(OpenObject arg)
SessionBuilder(Session base)

Method Summary

Modifier and Type	Method and Description
SessionBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Session>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Session> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Session>> E$$	augmentation(Class<E$$> augmentationType)
Session	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Open	getOpen()
SessionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Session>> augmentationType)
SessionBuilder	setOpen(Open value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionBuilder

public SessionBuilder()

SessionBuilder

public SessionBuilder(OpenObject arg)

SessionBuilder

public SessionBuilder(Session 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.OpenObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getOpen

public Open getOpen()

augmentation

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

setOpen

public SessionBuilder setOpen(Open value)

addAugmentation

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

removeAugmentation

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

build

public Session build()

Specified by:

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