Class InventoryNodeBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.inventory.rev131030.InventoryNodeBuilder
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedInventoryNode
. -
Method Summary
Modifier and TypeMethodDescription@NonNull InventoryNode
build()
A newInventoryNode
instance.Return current value associated with the property corresponding toInventoryNode.getInventoryNodeRef()
.setInventoryNodeRef
(NodeRef value) Set the property corresponding toInventoryNode.getInventoryNodeRef()
to the specified value.
-
Constructor Details
-
InventoryNodeBuilder
public InventoryNodeBuilder()Construct an empty builder. -
InventoryNodeBuilder
Construct a builder initialized with state from specifiedInventoryNode
.- Parameters:
base
- InventoryNode from which the builder should be initialized
-
-
Method Details
-
getInventoryNodeRef
Return current value associated with the property corresponding toInventoryNode.getInventoryNodeRef()
.- Returns:
- current value
-
setInventoryNodeRef
Set the property corresponding toInventoryNode.getInventoryNodeRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newInventoryNode
instance.- Returns:
- A new
InventoryNode
instance.
-