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

Class PcreqMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcreqMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PcreqMessage>

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

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

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

PcreqMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcreqMessageBuilder()
PcreqMessageBuilder(MessageHeader arg)
PcreqMessageBuilder(PcreqMessage base)

Method Summary

Modifier and Type	Method and Description
PcreqMessageBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage>> E$$	augmentation(Class<E$$> augmentationType)
PcreqMessage	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
MonitoringRequest	getMonitoringRequest()
List<Requests>	getRequests()
List<Svec>	getSvec()
ProtocolVersion	getVersion()
PcreqMessageBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage>> augmentationType)
PcreqMessageBuilder	setMonitoringRequest(MonitoringRequest value)
PcreqMessageBuilder	setRequests(List<Requests> values)
PcreqMessageBuilder	setSvec(List<Svec> values)
PcreqMessageBuilder	setVersion(ProtocolVersion value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PcreqMessageBuilder

public PcreqMessageBuilder()

PcreqMessageBuilder

public PcreqMessageBuilder(MessageHeader arg)

PcreqMessageBuilder

public PcreqMessageBuilder(PcreqMessage 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

getMonitoringRequest

public MonitoringRequest getMonitoringRequest()

getRequests

public List<Requests> getRequests()

getSvec

public List<Svec> getSvec()

getVersion

public ProtocolVersion getVersion()

augmentation

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

setMonitoringRequest

public PcreqMessageBuilder setMonitoringRequest(MonitoringRequest value)

setRequests

public PcreqMessageBuilder setRequests(List<Requests> values)

setSvec

public PcreqMessageBuilder setSvec(List<Svec> values)

setVersion

public PcreqMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public PcreqMessage build()

Specified by:

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