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

Class CCloseMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class CCloseMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<CCloseMessage>

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

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

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

CCloseMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
CCloseMessageBuilder()
CCloseMessageBuilder(CCloseMessage base)
CCloseMessageBuilder(CloseObject arg)
CCloseMessageBuilder(MessageHeader arg)

Method Summary

Modifier and Type	Method and Description
CCloseMessageBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CCloseMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CCloseMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CCloseMessage>> E$$	augmentation(Class<E$$> augmentationType)
CCloseMessage	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
CClose	getCClose()
ProtocolVersion	getVersion()
CCloseMessageBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CCloseMessage>> augmentationType)
CCloseMessageBuilder	setCClose(CClose value)
CCloseMessageBuilder	setVersion(ProtocolVersion value)

Methods inherited from class java.lang.Object

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

Constructor Detail

CCloseMessageBuilder

public CCloseMessageBuilder()

CCloseMessageBuilder

public CCloseMessageBuilder(MessageHeader arg)

CCloseMessageBuilder

public CCloseMessageBuilder(CloseObject arg)

CCloseMessageBuilder

public CCloseMessageBuilder(CCloseMessage 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.MessageHeader
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.CloseObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getCClose

public CClose getCClose()

getVersion

public ProtocolVersion getVersion()

augmentation

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

setCClose

public CCloseMessageBuilder setCClose(CClose value)

setVersion

public CCloseMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public CCloseMessage build()

Specified by:

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