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

Class KeepaliveMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class KeepaliveMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<KeepaliveMessage>

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

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

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

KeepaliveMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
KeepaliveMessageBuilder()
KeepaliveMessageBuilder(KeepaliveMessage base)
KeepaliveMessageBuilder(MessageHeader arg)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

KeepaliveMessageBuilder

public KeepaliveMessageBuilder()

KeepaliveMessageBuilder

public KeepaliveMessageBuilder(MessageHeader arg)

KeepaliveMessageBuilder

public KeepaliveMessageBuilder(KeepaliveMessage 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

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getVersion

public ProtocolVersion getVersion()

augmentation

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

setVersion

public KeepaliveMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public KeepaliveMessage build()

Specified by:

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