org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.of.list.tlv

Class OfListBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.of.list.tlv.OfListBuilder

All Implemented Interfaces:

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

public class OfListBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<OfList>

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

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

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

OfListBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
OfListBuilder()
OfListBuilder(OfList base)
OfListBuilder(Tlv arg)

Method Summary

Modifier and Type	Method and Description
OfListBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfList>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OfList> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OfList>> E$$	augmentation(Class<E$$> augmentationType)
OfList	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<OfId>	getCodes()
OfListBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfList>> augmentationType)
OfListBuilder	setCodes(List<OfId> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfListBuilder

public OfListBuilder()

OfListBuilder

public OfListBuilder(Tlv arg)

OfListBuilder

public OfListBuilder(OfList 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.Tlv

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getCodes

public List<OfId> getCodes()

augmentation

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

setCodes

public OfListBuilder setCodes(List<OfId> values)

addAugmentation

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

removeAugmentation

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

build

public OfList build()

Specified by:

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