org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109

Class StarttlsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.StarttlsBuilder

All Implemented Interfaces:

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

public class StarttlsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Starttls>

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

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

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

StarttlsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
StarttlsBuilder()
StarttlsBuilder(Message arg)
StarttlsBuilder(Starttls base)
StarttlsBuilder(StartTlsMessage arg)

Method Summary

Modifier and Type	Method and Description
StarttlsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Starttls> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> E$$	augmentation(Class<E$$> augmentationType)
Starttls	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
StartTlsMessage	getStartTlsMessage()
StarttlsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> augmentationType)
StarttlsBuilder	setStartTlsMessage(StartTlsMessage value)

Methods inherited from class java.lang.Object

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

Constructor Detail

StarttlsBuilder

public StarttlsBuilder()

StarttlsBuilder

public StarttlsBuilder(StartTlsMessage arg)

StarttlsBuilder

public StarttlsBuilder(Message arg)

StarttlsBuilder

public StarttlsBuilder(Starttls 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.StartTlsMessage
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getStartTlsMessage

public StartTlsMessage getStartTlsMessage()

augmentation

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

setStartTlsMessage

public StarttlsBuilder setStartTlsMessage(StartTlsMessage value)

addAugmentation

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

removeAugmentation

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

build

public Starttls build()

Specified by:

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