Class NodeGroupDescStatsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupDescStatsBuilder
Class that builds
NodeGroupDescStats
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:
NodeGroupDescStats createNodeGroupDescStats(int fooXyzzy, int barBaz) {
return new NodeGroupDescStatsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NodeGroupDescStats, 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 new builder initialized from specifiedGroupDesc
.Construct a builder initialized with state from specifiedNodeGroupDescStats
. -
Method Summary
Modifier and TypeMethodDescription@NonNull NodeGroupDescStats
build()
A newNodeGroupDescStats
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toGroupDesc.getGroupDesc()
.setGroupDesc
(GroupDesc value) Set the property corresponding toGroupDesc.getGroupDesc()
to the specified value.
-
Constructor Details
-
NodeGroupDescStatsBuilder
public NodeGroupDescStatsBuilder()Construct an empty builder. -
NodeGroupDescStatsBuilder
Construct a new builder initialized from specifiedGroupDesc
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupDesc from which the builder should be initialized
-
NodeGroupDescStatsBuilder
Construct a builder initialized with state from specifiedNodeGroupDescStats
.- Parameters:
base
- NodeGroupDescStats from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGroupDesc
Return current value associated with the property corresponding toGroupDesc.getGroupDesc()
.- Returns:
- current value
-
setGroupDesc
Set the property corresponding toGroupDesc.getGroupDesc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newNodeGroupDescStats
instance.- Returns:
- A new
NodeGroupDescStats
instance.
-