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

Class ErrorsBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class ErrorsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Errors>

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

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

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

ErrorsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ErrorsBuilder()
ErrorsBuilder(Errors base)
ErrorsBuilder(PcepErrorObject arg)

Method Summary

Modifier and Type	Method and Description
ErrorsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Errors>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Errors> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Errors>> E$$	augmentation(Class<E$$> augmentationType)
Errors	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
ErrorObject	getErrorObject()
ErrorsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Errors>> augmentationType)
ErrorsBuilder	setErrorObject(ErrorObject value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorsBuilder

public ErrorsBuilder()

ErrorsBuilder

public ErrorsBuilder(PcepErrorObject arg)

ErrorsBuilder

public ErrorsBuilder(Errors 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.PcepErrorObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getErrorObject

public ErrorObject getErrorObject()

augmentation

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

setErrorObject

public ErrorsBuilder setErrorObject(ErrorObject value)

addAugmentation

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

removeAugmentation

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

build

public Errors build()

Specified by:

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