Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709

Class TreeLeafOnlyUsesAugmentBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeLeafOnlyUsesAugmentBuilder

@Generated("mdsal-binding-generator")
public class TreeLeafOnlyUsesAugmentBuilder
extends Object

Class that builds TreeLeafOnlyUsesAugment 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:

   
     TreeLeafOnlyUsesAugment createTreeLeafOnlyUsesAugment(int fooXyzzy, int barBaz) {
         return new TreeLeafOnlyUsesAugmentBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of TreeLeafOnlyUsesAugment, 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:

TreeLeafOnlyUsesAugment

Constructor Summary

Constructors

Constructor	Description
TreeLeafOnlyUsesAugmentBuilder()	Construct an empty builder.
TreeLeafOnlyUsesAugmentBuilder(LeafFromGrouping arg)	Construct a new builder initialized from specified LeafFromGrouping.
TreeLeafOnlyUsesAugmentBuilder(TreeLeafOnlyUsesAugment base)	Construct a builder initialized with state from specified TreeLeafOnlyUsesAugment.

Method Summary

Modifier and Type	Method	Description
@NonNull TreeLeafOnlyUsesAugment	build()	A new TreeLeafOnlyUsesAugment instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
String	getLeafFromGrouping()	Return current value associated with the property corresponding to LeafFromGrouping.getLeafFromGrouping().
TreeLeafOnlyUsesAugmentBuilder	setLeafFromGrouping(String value)	Set the property corresponding to LeafFromGrouping.getLeafFromGrouping() to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeLeafOnlyUsesAugmentBuilder

public TreeLeafOnlyUsesAugmentBuilder()

Construct an empty builder.

TreeLeafOnlyUsesAugmentBuilder

public TreeLeafOnlyUsesAugmentBuilder(LeafFromGrouping arg)

Construct a new builder initialized from specified LeafFromGrouping.

Parameters:

arg - LeafFromGrouping from which the builder should be initialized

TreeLeafOnlyUsesAugmentBuilder

public TreeLeafOnlyUsesAugmentBuilder(TreeLeafOnlyUsesAugment base)

Construct a builder initialized with state from specified TreeLeafOnlyUsesAugment.

Parameters:

base - TreeLeafOnlyUsesAugment from which the builder should be initialized

Method Detail

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:

• LeafFromGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getLeafFromGrouping

public String getLeafFromGrouping()

Return current value associated with the property corresponding to LeafFromGrouping.getLeafFromGrouping().

Returns:

current value

setLeafFromGrouping

public TreeLeafOnlyUsesAugmentBuilder setLeafFromGrouping(String value)

Set the property corresponding to LeafFromGrouping.getLeafFromGrouping() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull TreeLeafOnlyUsesAugment build()

A new TreeLeafOnlyUsesAugment instance.

Returns:

A new TreeLeafOnlyUsesAugment instance.