Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.inventory.rev131030

Class InventoryNodeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.inventory.rev131030.InventoryNodeBuilder

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

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

   
     InventoryNode createInventoryNode(int fooXyzzy, int barBaz) {
         return new InventoryNodeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• InventoryNode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull InventoryNode	build()	A new InventoryNode instance.
NodeRef	getInventoryNodeRef()	Return current value associated with the property corresponding to InventoryNode.getInventoryNodeRef().
InventoryNodeBuilder	setInventoryNodeRef(NodeRef value)	Set the property corresponding to InventoryNode.getInventoryNodeRef() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryNodeBuilder

public InventoryNodeBuilder()

Construct an empty builder.

InventoryNodeBuilder

public InventoryNodeBuilder(InventoryNode base)

Construct a builder initialized with state from specified InventoryNode.

Parameters:

base - InventoryNode from which the builder should be initialized

Method Details

getInventoryNodeRef

public NodeRef getInventoryNodeRef()

Return current value associated with the property corresponding to InventoryNode.getInventoryNodeRef().

Returns:

current value

setInventoryNodeRef

public InventoryNodeBuilder setInventoryNodeRef(NodeRef value)

Set the property corresponding to InventoryNode.getInventoryNodeRef() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull InventoryNode build()

A new InventoryNode instance.

Returns:

A new InventoryNode instance.