org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bnc.object.branch.node.type

Class BranchNodeCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bnc.object.branch.node.type.BranchNodeCaseBuilder

All Implemented Interfaces:

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

public class BranchNodeCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BranchNodeCase>

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

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

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

BranchNodeCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BranchNodeCaseBuilder()
BranchNodeCaseBuilder(BranchNodeCase base)
BranchNodeCaseBuilder(BranchNodeObject arg)

Method Summary

Modifier and Type	Method and Description
BranchNodeCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> E$$	augmentation(Class<E$$> augmentationType)
BranchNodeCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
BranchNodeList	getBranchNodeList()
BranchNodeCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> augmentationType)
BranchNodeCaseBuilder	setBranchNodeList(BranchNodeList value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchNodeCaseBuilder

public BranchNodeCaseBuilder()

BranchNodeCaseBuilder

public BranchNodeCaseBuilder(BranchNodeObject arg)

BranchNodeCaseBuilder

public BranchNodeCaseBuilder(BranchNodeCase 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.BranchNodeObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getBranchNodeList

public BranchNodeList getBranchNodeList()

augmentation

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

setBranchNodeList

public BranchNodeCaseBuilder setBranchNodeList(BranchNodeList value)

addAugmentation

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

removeAugmentation

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

build

public BranchNodeCase build()

Specified by:

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