Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422

Class ListsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422.ListsBuilder

All Implemented Interfaces:

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

public class ListsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Lists>

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

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

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

ListsBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
ListsBuilder()
ListsBuilder(Lists base)

Method Summary

Modifier and Type	Method	Description
ListsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lists>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Lists> augmentationValue)	Deprecated, for removal: This API element is subject to removal in a future version. Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
ListsBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Lists> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lists>> E$$	augmentation(Class<E$$> augmentationType)
Lists	build()
OrderedContainer	getOrderedContainer()
UnkeyedContainer	getUnkeyedContainer()
UnorderedContainer	getUnorderedContainer()
ListsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lists>> augmentationType)	Remove an augmentation from this builder's product.
ListsBuilder	setOrderedContainer(OrderedContainer value)
ListsBuilder	setUnkeyedContainer(UnkeyedContainer value)
ListsBuilder	setUnorderedContainer(UnorderedContainer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListsBuilder

public ListsBuilder()

ListsBuilder

public ListsBuilder(Lists base)

Method Detail

getOrderedContainer

public OrderedContainer getOrderedContainer()

getUnkeyedContainer

public UnkeyedContainer getUnkeyedContainer()

getUnorderedContainer

public UnorderedContainer getUnorderedContainer()

augmentation

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

setOrderedContainer

public ListsBuilder setOrderedContainer(OrderedContainer value)

setUnkeyedContainer

public ListsBuilder setUnkeyedContainer(UnkeyedContainer value)

setUnorderedContainer

public ListsBuilder setUnorderedContainer(UnorderedContainer value)

addAugmentation

public ListsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Lists> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

addAugmentation

@Deprecated(forRemoval=true)
public ListsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lists>> augmentationType,
                                    org.opendaylight.yangtools.yang.binding.Augmentation<Lists> augmentationValue)

Deprecated, for removal: This API element is subject to removal in a future version.

Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.

Add or remove an augmentation to this builder's product.

Parameters:

augmentationType - augmentation type to be added or removed

augmentationValue - augmentation value, null if the augmentation type should be removed

Returns:

this builder

removeAugmentation

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

Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.

Parameters:

augmentationType - augmentation type to be removed

Returns:

this builder

build

public Lists build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Lists>

Specified by:

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