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

Class UnorderedContainerBuilder

java.lang.Object

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

@Generated("mdsal-binding-generator")
public class UnorderedContainerBuilder
extends Object

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

   
     UnorderedContainer createUnorderedContainer(int fooXyzzy, int barBaz) {
         return new UnorderedContainerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• UnorderedContainer

Constructor Summary

Constructors

Constructor	Description
UnorderedContainerBuilder()	Construct an empty builder.
UnorderedContainerBuilder(UnorderedContainer base)	Construct a builder initialized with state from specified UnorderedContainer.

Method Summary

Modifier and Type	Method	Description
UnorderedContainerBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnorderedContainer> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnorderedContainer>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull UnorderedContainer	build()	A new UnorderedContainer instance.
static @NonNull UnorderedContainer	empty()	Get empty instance of UnorderedContainer.
Map<UnorderedListKey,UnorderedList>	getUnorderedList()	Return current value associated with the property corresponding to UnorderedContainer.getUnorderedList().
UnorderedContainerBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnorderedContainer>> augmentationType)	Remove an augmentation from this builder's product.
UnorderedContainerBuilder	setUnorderedList(Map<UnorderedListKey,UnorderedList> values)	Set the property corresponding to UnorderedContainer.getUnorderedList() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

UnorderedContainerBuilder

public UnorderedContainerBuilder()

Construct an empty builder.

UnorderedContainerBuilder

public UnorderedContainerBuilder(UnorderedContainer base)

Construct a builder initialized with state from specified UnorderedContainer.

Parameters:

base - UnorderedContainer from which the builder should be initialized

Method Details

empty

public static @NonNull UnorderedContainer empty()

Get empty instance of UnorderedContainer.

Returns:

An empty UnorderedContainer

getUnorderedList

public Map<UnorderedListKey,UnorderedList> getUnorderedList()

Return current value associated with the property corresponding to UnorderedContainer.getUnorderedList().

Returns:

current value

augmentation

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

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setUnorderedList

public UnorderedContainerBuilder setUnorderedList(Map<UnorderedListKey,UnorderedList> values)

Set the property corresponding to UnorderedContainer.getUnorderedList() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

public UnorderedContainerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnorderedContainer> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public UnorderedContainerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnorderedContainer>> 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 @NonNull UnorderedContainer build()

A new UnorderedContainer instance.

Returns:

A new UnorderedContainer instance.