Class InventoryNodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.inventory.rev131030.InventoryNodeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InventoryNode>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InventoryNode,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InventoryNodeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InventoryNode>
Class that buildsInventoryNode
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description InventoryNodeBuilder()
InventoryNodeBuilder(InventoryNode base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InventoryNode
build()
NodeRef
getInventoryNodeRef()
InventoryNodeBuilder
setInventoryNodeRef(NodeRef value)
-
-
-
Constructor Detail
-
InventoryNodeBuilder
public InventoryNodeBuilder()
-
InventoryNodeBuilder
public InventoryNodeBuilder(InventoryNode base)
-
-
Method Detail
-
getInventoryNodeRef
public NodeRef getInventoryNodeRef()
-
setInventoryNodeRef
public InventoryNodeBuilder setInventoryNodeRef(NodeRef value)
-
build
public InventoryNode build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InventoryNode>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InventoryNode,IllegalArgumentException>
-
-