org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object

Class ErrorObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObjectBuilder

All Implemented Interfaces:

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

public class ErrorObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<ErrorObject>

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

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

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

ErrorObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ErrorObjectBuilder()
ErrorObjectBuilder(ErrorObject base)
ErrorObjectBuilder(Object arg)
ErrorObjectBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
ErrorObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> E$$	augmentation(Class<E$$> augmentationType)
ErrorObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Tlvs	getTlvs()
Short	getType()
Short	getValue()
Boolean	isIgnore()
Boolean	isProcessingRule()
ErrorObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> augmentationType)
ErrorObjectBuilder	setIgnore(Boolean value)
ErrorObjectBuilder	setProcessingRule(Boolean value)
ErrorObjectBuilder	setTlvs(Tlvs value)
ErrorObjectBuilder	setType(Short value)
ErrorObjectBuilder	setValue(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorObjectBuilder

public ErrorObjectBuilder()

ErrorObjectBuilder

public ErrorObjectBuilder(Object arg)

ErrorObjectBuilder

public ErrorObjectBuilder(ObjectHeader arg)

ErrorObjectBuilder

public ErrorObjectBuilder(ErrorObject 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.ObjectHeader
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getTlvs

public Tlvs getTlvs()

getType

public Short getType()

getValue

public Short getValue()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setTlvs

public ErrorObjectBuilder setTlvs(Tlvs value)

setType

public ErrorObjectBuilder setType(Short value)

setValue

public ErrorObjectBuilder setValue(Short value)

setIgnore

public ErrorObjectBuilder setIgnore(Boolean value)

setProcessingRule

public ErrorObjectBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public ErrorObject build()

Specified by:

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