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

Class PcntfBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PcntfBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Pcntf>

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

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

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

PcntfBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PcntfBuilder()
PcntfBuilder(Message arg)
PcntfBuilder(Pcntf base)
PcntfBuilder(PcntfMessage arg)

Method Summary

Modifier and Type	Method and Description
PcntfBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcntf>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Pcntf> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcntf>> E$$	augmentation(Class<E$$> augmentationType)
Pcntf	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
PcntfMessage	getPcntfMessage()
PcntfBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcntf>> augmentationType)
PcntfBuilder	setPcntfMessage(PcntfMessage value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PcntfBuilder

public PcntfBuilder()

PcntfBuilder

public PcntfBuilder(PcntfMessage arg)

PcntfBuilder

public PcntfBuilder(Message arg)

PcntfBuilder

public PcntfBuilder(Pcntf 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.PcntfMessage
• 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

getPcntfMessage

public PcntfMessage getPcntfMessage()

augmentation

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

setPcntfMessage

public PcntfBuilder setPcntfMessage(PcntfMessage value)

addAugmentation

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

removeAugmentation

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

build

public Pcntf build()

Specified by:

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