Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105

Class TopologyTypeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TopologyTypeBuilder

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

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

   
     TopologyType createTopologyType(int fooXyzzy, int barBaz) {
         return new TopologyTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

TopologyType

Constructor Summary

Constructors

Constructor	Description
TopologyTypeBuilder()	Construct an empty builder.
TopologyTypeBuilder(TopologyType base)	Construct a builder initialized with state from specified TopologyType.
TopologyTypeBuilder(TopologyTypeAttributes arg)	Construct a new builder initialized from specified TopologyTypeAttributes.

Method Summary

Modifier and Type	Method	Description
@NonNull TopologyType	build()	A new TopologyType instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Class<? extends TopologyTypeBase>	getTopologyType()	Return current value associated with the property corresponding to TopologyTypeAttributes.getTopologyType().
TopologyTypeBuilder	setTopologyType(Class<? extends TopologyTypeBase> value)	Set the property corresponding to TopologyTypeAttributes.getTopologyType() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologyTypeBuilder

public TopologyTypeBuilder()

Construct an empty builder.

TopologyTypeBuilder

public TopologyTypeBuilder(TopologyTypeAttributes arg)

Construct a new builder initialized from specified TopologyTypeAttributes.

Parameters:

arg - TopologyTypeAttributes from which the builder should be initialized

TopologyTypeBuilder

public TopologyTypeBuilder(TopologyType base)

Construct a builder initialized with state from specified TopologyType.

Parameters:

base - TopologyType 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:

• TopologyTypeAttributes

Parameters:

arg - grouping object

Throws:

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

getTopologyType

public Class<? extends TopologyTypeBase> getTopologyType()

Return current value associated with the property corresponding to TopologyTypeAttributes.getTopologyType().

Returns:

current value

setTopologyType

public TopologyTypeBuilder setTopologyType(Class<? extends TopologyTypeBase> value)

Set the property corresponding to TopologyTypeAttributes.getTopologyType() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull TopologyType build()

A new TopologyType instance.

Returns:

A new TopologyType instance.