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

Class PcrepBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcrepBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Pcrep>

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

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

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

PcrepBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcrepBuilder()
PcrepBuilder(Message arg)
PcrepBuilder(Pcrep base)
PcrepBuilder(PcrepMessage arg)

Method Summary

Modifier and Type	Method and Description
PcrepBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcrep>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Pcrep> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcrep>> E$$	augmentation(Class<E$$> augmentationType)
Pcrep	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
PcrepMessage	getPcrepMessage()
PcrepBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcrep>> augmentationType)
PcrepBuilder	setPcrepMessage(PcrepMessage value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PcrepBuilder

public PcrepBuilder()

PcrepBuilder

public PcrepBuilder(PcrepMessage arg)

PcrepBuilder

public PcrepBuilder(Message arg)

PcrepBuilder

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

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPcrepMessage

public PcrepMessage getPcrepMessage()

augmentation

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

setPcrepMessage

public PcrepBuilder setPcrepMessage(PcrepMessage value)

addAugmentation

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

removeAugmentation

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

build

public Pcrep build()

Specified by:

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