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

Class PcerrBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcerrBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Pcerr>

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

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

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

PcerrBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcerrBuilder()
PcerrBuilder(Message arg)
PcerrBuilder(Pcerr base)
PcerrBuilder(PcerrMessage arg)

Method Summary

Modifier and Type	Method and Description
PcerrBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcerr>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Pcerr> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcerr>> E$$	augmentation(Class<E$$> augmentationType)
Pcerr	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
PcerrMessage	getPcerrMessage()
PcerrBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcerr>> augmentationType)
PcerrBuilder	setPcerrMessage(PcerrMessage value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PcerrBuilder

public PcerrBuilder()

PcerrBuilder

public PcerrBuilder(PcerrMessage arg)

PcerrBuilder

public PcerrBuilder(Message arg)

PcerrBuilder

public PcerrBuilder(Pcerr 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.PcerrMessage
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPcerrMessage

public PcerrMessage getPcerrMessage()

augmentation

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

setPcerrMessage

public PcerrBuilder setPcerrMessage(PcerrMessage value)

addAugmentation

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

removeAugmentation

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

build

public Pcerr build()

Specified by:

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