Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top

Class NetworkInstancesBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstancesBuilder

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

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

   
     NetworkInstances createNetworkInstances(int fooXyzzy, int barBaz) {
         return new NetworkInstancesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• NetworkInstances

Constructor Summary

Constructors

Constructor	Description
NetworkInstancesBuilder()	Construct an empty builder.
NetworkInstancesBuilder(NetworkInstances base)	Construct a builder initialized with state from specified NetworkInstances.

Method Summary

Modifier and Type	Method	Description
NetworkInstancesBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull NetworkInstances	build()	A new NetworkInstances instance.
static @NonNull NetworkInstances	empty()	Get empty instance of NetworkInstances.
Map<NetworkInstanceKey,NetworkInstance>	getNetworkInstance()	Return current value associated with the property corresponding to NetworkInstances.getNetworkInstance().
NetworkInstancesBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType)	Remove an augmentation from this builder's product.
NetworkInstancesBuilder	setNetworkInstance(Map<NetworkInstanceKey,NetworkInstance> values)	Set the property corresponding to NetworkInstances.getNetworkInstance() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

NetworkInstancesBuilder

public NetworkInstancesBuilder()

Construct an empty builder.

NetworkInstancesBuilder

public NetworkInstancesBuilder(NetworkInstances base)

Construct a builder initialized with state from specified NetworkInstances.

Parameters:

base - NetworkInstances from which the builder should be initialized

Method Details

empty

public static @NonNull NetworkInstances empty()

Get empty instance of NetworkInstances.

Returns:

An empty NetworkInstances

getNetworkInstance

public Map<NetworkInstanceKey,NetworkInstance> getNetworkInstance()

Return current value associated with the property corresponding to NetworkInstances.getNetworkInstance().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>>
E$$ augmentation(Class<E$$> augmentationType)

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setNetworkInstance

public NetworkInstancesBuilder setNetworkInstance(Map<NetworkInstanceKey,NetworkInstance> values)

Set the property corresponding to NetworkInstances.getNetworkInstance() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

public NetworkInstancesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public NetworkInstancesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType)

Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.

Parameters:

augmentationType - augmentation type to be removed

Returns:

this builder

build

public @NonNull NetworkInstances build()

A new NetworkInstances instance.

Returns:

A new NetworkInstances instance.