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

Class BranchNodeListBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class BranchNodeListBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BranchNodeList>

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

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

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

BranchNodeListBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BranchNodeListBuilder()
BranchNodeListBuilder(Bnc arg)
BranchNodeListBuilder(BranchNodeList base)
BranchNodeListBuilder(Object arg)
BranchNodeListBuilder(ObjectHeader arg)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchNodeListBuilder

public BranchNodeListBuilder()

BranchNodeListBuilder

public BranchNodeListBuilder(Bnc arg)

BranchNodeListBuilder

public BranchNodeListBuilder(Object arg)

BranchNodeListBuilder

public BranchNodeListBuilder(ObjectHeader arg)

BranchNodeListBuilder

public BranchNodeListBuilder(BranchNodeList 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
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Bnc

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<BranchNodeList>> E$$ augmentation(Class<E$$> augmentationType)

setSubobject

public BranchNodeListBuilder setSubobject(List<Subobject> values)

setIgnore

public BranchNodeListBuilder setIgnore(Boolean value)

setProcessingRule

public BranchNodeListBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public BranchNodeList build()

Specified by:

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