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

Class PcntfMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcntfMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PcntfMessage>

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

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

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

PcntfMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcntfMessageBuilder()
PcntfMessageBuilder(MessageHeader arg)
PcntfMessageBuilder(PcntfMessage base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PcntfMessageBuilder

public PcntfMessageBuilder()

PcntfMessageBuilder

public PcntfMessageBuilder(MessageHeader arg)

PcntfMessageBuilder

public PcntfMessageBuilder(PcntfMessage 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

getNotifications

public List<Notifications> getNotifications()

getVersion

public ProtocolVersion getVersion()

augmentation

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

setNotifications

public PcntfMessageBuilder setNotifications(List<Notifications> values)

setVersion

public PcntfMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public PcntfMessage build()

Specified by:

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