Class NetworkInstanceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceBuilder
-
@Generated("mdsal-binding-generator") public class NetworkInstanceBuilder extends Object
Class that buildsNetworkInstance
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:
NetworkInstance createNetworkInstance(int fooXyzzy, int barBaz) { return new NetworkInstanceBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkInstance, 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:
NetworkInstance
- 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
-
-
Constructor Summary
Constructors Constructor Description NetworkInstanceBuilder()
Construct an empty builder.NetworkInstanceBuilder(NetworkInstance base)
Construct a builder initialized with state from specifiedNetworkInstance
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NetworkInstanceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NetworkInstance
build()
A newNetworkInstance
instance.Config
getConfig()
Return current value associated with the property corresponding toNetworkInstance.getConfig()
.ConnectionPoints
getConnectionPoints()
Return current value associated with the property corresponding toNetworkInstance.getConnectionPoints()
.Interfaces
getInterfaces()
Return current value associated with the property corresponding toNetworkInstance.getInterfaces()
.InterInstancePolicies
getInterInstancePolicies()
Return current value associated with the property corresponding toNetworkInstance.getInterInstancePolicies()
.String
getName()
Return current value associated with the property corresponding toNetworkInstance.getName()
.Protocols
getProtocols()
Return current value associated with the property corresponding toNetworkInstance.getProtocols()
.State
getState()
Return current value associated with the property corresponding toNetworkInstance.getState()
.TableConnections
getTableConnections()
Return current value associated with the property corresponding toNetworkInstance.getTableConnections()
.Tables
getTables()
Return current value associated with the property corresponding toNetworkInstance.getTables()
.NetworkInstanceKey
key()
Return current value associated with the property corresponding toNetworkInstance.key()
.NetworkInstanceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> augmentationType)
Remove an augmentation from this builder's product.NetworkInstanceBuilder
setConfig(Config value)
Set the property corresponding toNetworkInstance.getConfig()
to the specified value.NetworkInstanceBuilder
setConnectionPoints(ConnectionPoints value)
Set the property corresponding toNetworkInstance.getConnectionPoints()
to the specified value.NetworkInstanceBuilder
setInterfaces(Interfaces value)
Set the property corresponding toNetworkInstance.getInterfaces()
to the specified value.NetworkInstanceBuilder
setInterInstancePolicies(InterInstancePolicies value)
Set the property corresponding toNetworkInstance.getInterInstancePolicies()
to the specified value.NetworkInstanceBuilder
setName(String value)
Set the property corresponding toNetworkInstance.getName()
to the specified value.NetworkInstanceBuilder
setProtocols(Protocols value)
Set the property corresponding toNetworkInstance.getProtocols()
to the specified value.NetworkInstanceBuilder
setState(State value)
Set the property corresponding toNetworkInstance.getState()
to the specified value.NetworkInstanceBuilder
setTableConnections(TableConnections value)
Set the property corresponding toNetworkInstance.getTableConnections()
to the specified value.NetworkInstanceBuilder
setTables(Tables value)
Set the property corresponding toNetworkInstance.getTables()
to the specified value.NetworkInstanceBuilder
withKey(NetworkInstanceKey key)
-
-
-
Constructor Detail
-
NetworkInstanceBuilder
public NetworkInstanceBuilder()
Construct an empty builder.
-
NetworkInstanceBuilder
public NetworkInstanceBuilder(NetworkInstance base)
Construct a builder initialized with state from specifiedNetworkInstance
.- Parameters:
base
- NetworkInstance from which the builder should be initialized
-
-
Method Detail
-
key
public NetworkInstanceKey key()
Return current value associated with the property corresponding toNetworkInstance.key()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toNetworkInstance.getConfig()
.- Returns:
- current value
-
getConnectionPoints
public ConnectionPoints getConnectionPoints()
Return current value associated with the property corresponding toNetworkInstance.getConnectionPoints()
.- Returns:
- current value
-
getInterInstancePolicies
public InterInstancePolicies getInterInstancePolicies()
Return current value associated with the property corresponding toNetworkInstance.getInterInstancePolicies()
.- Returns:
- current value
-
getInterfaces
public Interfaces getInterfaces()
Return current value associated with the property corresponding toNetworkInstance.getInterfaces()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toNetworkInstance.getName()
.- Returns:
- current value
-
getProtocols
public Protocols getProtocols()
Return current value associated with the property corresponding toNetworkInstance.getProtocols()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toNetworkInstance.getState()
.- Returns:
- current value
-
getTableConnections
public TableConnections getTableConnections()
Return current value associated with the property corresponding toNetworkInstance.getTableConnections()
.- Returns:
- current value
-
getTables
public Tables getTables()
Return current value associated with the property corresponding toNetworkInstance.getTables()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> 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
- ifaugmentType
isnull
-
withKey
public NetworkInstanceBuilder withKey(NetworkInstanceKey key)
-
setConfig
public NetworkInstanceBuilder setConfig(Config value)
Set the property corresponding toNetworkInstance.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConnectionPoints
public NetworkInstanceBuilder setConnectionPoints(ConnectionPoints value)
Set the property corresponding toNetworkInstance.getConnectionPoints()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInterInstancePolicies
public NetworkInstanceBuilder setInterInstancePolicies(InterInstancePolicies value)
Set the property corresponding toNetworkInstance.getInterInstancePolicies()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInterfaces
public NetworkInstanceBuilder setInterfaces(Interfaces value)
Set the property corresponding toNetworkInstance.getInterfaces()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public NetworkInstanceBuilder setName(String value)
Set the property corresponding toNetworkInstance.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocols
public NetworkInstanceBuilder setProtocols(Protocols value)
Set the property corresponding toNetworkInstance.getProtocols()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public NetworkInstanceBuilder setState(State value)
Set the property corresponding toNetworkInstance.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableConnections
public NetworkInstanceBuilder setTableConnections(TableConnections value)
Set the property corresponding toNetworkInstance.getTableConnections()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTables
public NetworkInstanceBuilder setTables(Tables value)
Set the property corresponding toNetworkInstance.getTables()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NetworkInstanceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NetworkInstanceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> 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 NetworkInstance build()
A newNetworkInstance
instance.- Returns:
- A new
NetworkInstance
instance.
-
-