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

Class PcrepMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcrepMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PcrepMessage>

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

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

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

PcrepMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcrepMessageBuilder()
PcrepMessageBuilder(MessageHeader arg)
PcrepMessageBuilder(PcrepMessage base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PcrepMessageBuilder

public PcrepMessageBuilder()

PcrepMessageBuilder

public PcrepMessageBuilder(MessageHeader arg)

PcrepMessageBuilder

public PcrepMessageBuilder(PcrepMessage 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

getReplies

public List<Replies> getReplies()

getVersion

public ProtocolVersion getVersion()

augmentation

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

setReplies

public PcrepMessageBuilder setReplies(List<Replies> values)

setVersion

public PcrepMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public PcrepMessage build()

Specified by:

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