Class RpcLeafOnlyUsesAugmentBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.RpcLeafOnlyUsesAugmentBuilder
Class that builds
RpcLeafOnlyUsesAugment 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:
RpcLeafOnlyUsesAugment createRpcLeafOnlyUsesAugment(int fooXyzzy, int barBaz) {
return new RpcLeafOnlyUsesAugmentBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RpcLeafOnlyUsesAugment, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedLeafFromGrouping.Construct a builder initialized with state from specifiedRpcLeafOnlyUsesAugment. -
Method Summary
Modifier and TypeMethodDescription@NonNull RpcLeafOnlyUsesAugmentbuild()A newRpcLeafOnlyUsesAugmentinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLeafFromGrouping.getLeafFromGrouping().setLeafFromGrouping(String value) Set the property corresponding toLeafFromGrouping.getLeafFromGrouping()to the specified value.
-
Constructor Details
-
RpcLeafOnlyUsesAugmentBuilder
public RpcLeafOnlyUsesAugmentBuilder()Construct an empty builder. -
RpcLeafOnlyUsesAugmentBuilder
Construct a new builder initialized from specifiedLeafFromGrouping.- Parameters:
arg- LeafFromGrouping from which the builder should be initialized
-
RpcLeafOnlyUsesAugmentBuilder
Construct a builder initialized with state from specifiedRpcLeafOnlyUsesAugment.- Parameters:
base- RpcLeafOnlyUsesAugment 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
-
getLeafFromGrouping
Return current value associated with the property corresponding toLeafFromGrouping.getLeafFromGrouping().- Returns:
- current value
-
setLeafFromGrouping
Set the property corresponding toLeafFromGrouping.getLeafFromGrouping()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
A newRpcLeafOnlyUsesAugmentinstance.- Returns:
- A new
RpcLeafOnlyUsesAugmentinstance.
-