Class InventoryNodeConnectorBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.inventory.rev131030.InventoryNodeConnectorBuilder
Class that builds
InventoryNodeConnector
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:
InventoryNodeConnector createInventoryNodeConnector(int fooXyzzy, int barBaz) {
return new InventoryNodeConnectorBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of InventoryNodeConnector, 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 specifiedInventoryNodeConnector
. -
Method Summary
Modifier and TypeMethodDescription@NonNull InventoryNodeConnector
build()
A newInventoryNodeConnector
instance.Return current value associated with the property corresponding toInventoryNodeConnector.getInventoryNodeConnectorRef()
.Set the property corresponding toInventoryNodeConnector.getInventoryNodeConnectorRef()
to the specified value.
-
Constructor Details
-
InventoryNodeConnectorBuilder
public InventoryNodeConnectorBuilder()Construct an empty builder. -
InventoryNodeConnectorBuilder
Construct a builder initialized with state from specifiedInventoryNodeConnector
.- Parameters:
base
- InventoryNodeConnector from which the builder should be initialized
-
-
Method Details
-
getInventoryNodeConnectorRef
Return current value associated with the property corresponding toInventoryNodeConnector.getInventoryNodeConnectorRef()
.- Returns:
- current value
-
setInventoryNodeConnectorRef
Set the property corresponding toInventoryNodeConnector.getInventoryNodeConnectorRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newInventoryNodeConnector
instance.- Returns:
- A new
InventoryNodeConnector
instance.
-