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

Class PcerrMessageBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcerrMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PcerrMessage>

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

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

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

PcerrMessageBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcerrMessageBuilder()
PcerrMessageBuilder(MessageHeader arg)
PcerrMessageBuilder(PcerrMessage base)

Method Summary

Modifier and Type	Method and Description
PcerrMessageBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> E$$	augmentation(Class<E$$> augmentationType)
PcerrMessage	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Errors>	getErrors()
ErrorType	getErrorType()
ProtocolVersion	getVersion()
PcerrMessageBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> augmentationType)
PcerrMessageBuilder	setErrors(List<Errors> values)
PcerrMessageBuilder	setErrorType(ErrorType value)
PcerrMessageBuilder	setVersion(ProtocolVersion value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PcerrMessageBuilder

public PcerrMessageBuilder()

PcerrMessageBuilder

public PcerrMessageBuilder(MessageHeader arg)

PcerrMessageBuilder

public PcerrMessageBuilder(PcerrMessage 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

getErrorType

public ErrorType getErrorType()

getErrors

public List<Errors> getErrors()

getVersion

public ProtocolVersion getVersion()

augmentation

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

setErrorType

public PcerrMessageBuilder setErrorType(ErrorType value)

setErrors

public PcerrMessageBuilder setErrors(List<Errors> values)

setVersion

public PcerrMessageBuilder setVersion(ProtocolVersion value)

addAugmentation

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

removeAugmentation

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

build

public PcerrMessage build()

Specified by:

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