org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2mp.iro.bnc.choice

Class IroCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2mp.iro.bnc.choice.IroCaseBuilder

All Implemented Interfaces:

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

public class IroCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<IroCase>

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

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

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

IroCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
IroCaseBuilder()
IroCaseBuilder(IncludeRouteObject arg)
IroCaseBuilder(IroCase base)

Method Summary

Modifier and Type	Method and Description
IroCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IroCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IroCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IroCase>> E$$	augmentation(Class<E$$> augmentationType)
IroCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Iro	getIro()
IroCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IroCase>> augmentationType)
IroCaseBuilder	setIro(Iro value)

Methods inherited from class java.lang.Object

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

Constructor Detail

IroCaseBuilder

public IroCaseBuilder()

IroCaseBuilder

public IroCaseBuilder(IncludeRouteObject arg)

IroCaseBuilder

public IroCaseBuilder(IroCase 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.IncludeRouteObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getIro

public Iro getIro()

augmentation

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

setIro

public IroCaseBuilder setIro(Iro value)

addAugmentation

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

removeAugmentation

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

build

public IroCase build()

Specified by:

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