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

Class CloseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class CloseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Close>

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

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

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

CloseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
CloseBuilder()
CloseBuilder(Close base)
CloseBuilder(CloseMessage arg)
CloseBuilder(Message arg)

Method Summary

Modifier and Type	Method and Description
CloseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Close> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> E$$	augmentation(Class<E$$> augmentationType)
Close	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
CCloseMessage	getCCloseMessage()
CloseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> augmentationType)
CloseBuilder	setCCloseMessage(CCloseMessage value)

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseBuilder

public CloseBuilder()

CloseBuilder

public CloseBuilder(CloseMessage arg)

CloseBuilder

public CloseBuilder(Message arg)

CloseBuilder

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

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getCCloseMessage

public CCloseMessage getCCloseMessage()

augmentation

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

setCCloseMessage

public CloseBuilder setCCloseMessage(CCloseMessage value)

addAugmentation

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

removeAugmentation

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

build

public Close build()

Specified by:

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