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

Class IroBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.include.route.object.IroBuilder

All Implemented Interfaces:

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

public class IroBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Iro>

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

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

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

IroBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
IroBuilder()
IroBuilder(Iro base)
IroBuilder(Object arg)
IroBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
IroBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Iro>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Iro> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Iro>> E$$	augmentation(Class<E$$> augmentationType)
Iro	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Subobject>	getSubobject()
Boolean	isIgnore()
Boolean	isProcessingRule()
IroBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Iro>> augmentationType)
IroBuilder	setIgnore(Boolean value)
IroBuilder	setProcessingRule(Boolean value)
IroBuilder	setSubobject(List<Subobject> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

IroBuilder

public IroBuilder()

IroBuilder

public IroBuilder(Object arg)

IroBuilder

public IroBuilder(ObjectHeader arg)

IroBuilder

public IroBuilder(Iro 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

getSubobject

public List<Subobject> getSubobject()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setSubobject

public IroBuilder setSubobject(List<Subobject> values)

setIgnore

public IroBuilder setIgnore(Boolean value)

setProcessingRule

public IroBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Iro build()

Specified by:

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