Class TreeComplexUsesAugmentBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugmentBuilder
Class that builds
TreeComplexUsesAugment 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:
TreeComplexUsesAugment createTreeComplexUsesAugment(int fooXyzzy, int barBaz) {
return new TreeComplexUsesAugmentBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TreeComplexUsesAugment, 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 specifiedComplexFromGrouping.Construct a builder initialized with state from specifiedTreeComplexUsesAugment. -
Method Summary
Modifier and TypeMethodDescription@NonNull TreeComplexUsesAugmentbuild()A newTreeComplexUsesAugmentinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toComplexFromGrouping.getContainerWithUses().Return current value associated with the property corresponding toComplexFromGrouping.getListViaUses().Set the property corresponding toComplexFromGrouping.getContainerWithUses()to the specified value.setListViaUses(Map<ListViaUsesKey, ListViaUses> values) Set the property corresponding toComplexFromGrouping.getListViaUses()to the specified value.
-
Constructor Details
-
TreeComplexUsesAugmentBuilder
public TreeComplexUsesAugmentBuilder()Construct an empty builder. -
TreeComplexUsesAugmentBuilder
Construct a new builder initialized from specifiedComplexFromGrouping.- Parameters:
arg- ComplexFromGrouping from which the builder should be initialized
-
TreeComplexUsesAugmentBuilder
Construct a builder initialized with state from specifiedTreeComplexUsesAugment.- Parameters:
base- TreeComplexUsesAugment 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
-
getContainerWithUses
Return current value associated with the property corresponding toComplexFromGrouping.getContainerWithUses().- Returns:
- current value
-
getListViaUses
Return current value associated with the property corresponding toComplexFromGrouping.getListViaUses().- Returns:
- current value
-
setContainerWithUses
Set the property corresponding toComplexFromGrouping.getContainerWithUses()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setListViaUses
Set the property corresponding toComplexFromGrouping.getListViaUses()to the specified value.- Parameters:
values- desired value- Returns:
- this builder
-
build
A newTreeComplexUsesAugmentinstance.- Returns:
- A new
TreeComplexUsesAugmentinstance.
-