org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case

Class SuccessBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case.SuccessBuilder

All Implemented Interfaces:

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

public class SuccessBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Success>

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

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

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

SuccessBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SuccessBuilder()
SuccessBuilder(Success base)
SuccessBuilder(VendorInformationObjects arg)

Method Summary

Modifier and Type	Method and Description
SuccessBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Success> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>> E$$	augmentation(Class<E$$> augmentationType)
Success	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Paths>	getPaths()
List<VendorInformationObject>	getVendorInformationObject()
SuccessBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>> augmentationType)
SuccessBuilder	setPaths(List<Paths> values)
SuccessBuilder	setVendorInformationObject(List<VendorInformationObject> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuccessBuilder

public SuccessBuilder()

SuccessBuilder

public SuccessBuilder(VendorInformationObjects arg)

SuccessBuilder

public SuccessBuilder(Success 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.VendorInformationObjects

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPaths

public List<Paths> getPaths()

getVendorInformationObject

public List<VendorInformationObject> getVendorInformationObject()

augmentation

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

setPaths

public SuccessBuilder setPaths(List<Paths> values)

setVendorInformationObject

public SuccessBuilder setVendorInformationObject(List<VendorInformationObject> values)

addAugmentation

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

removeAugmentation

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

build

public Success build()

Specified by:

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