Class NetworkInstanceBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceBuilder
Class that builds
NetworkInstance
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedNetworkInstance
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.Return current value associated with the property corresponding toNetworkInstance.getConfig()
.Return current value associated with the property corresponding toNetworkInstance.getConnectionPoints()
.Return current value associated with the property corresponding toNetworkInstance.getInterfaces()
.Return current value associated with the property corresponding toNetworkInstance.getInterInstancePolicies()
.getName()
Return current value associated with the property corresponding toNetworkInstance.getName()
.Return current value associated with the property corresponding toNetworkInstance.getProtocols()
.getState()
Return current value associated with the property corresponding toNetworkInstance.getState()
.Return current value associated with the property corresponding toNetworkInstance.getTableConnections()
.Return current value associated with the property corresponding toNetworkInstance.getTables()
.key()
Return current value associated with the property corresponding toNetworkInstance.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toNetworkInstance.getConfig()
to the specified value.Set the property corresponding toNetworkInstance.getConnectionPoints()
to the specified value.setInterfaces
(Interfaces value) Set the property corresponding toNetworkInstance.getInterfaces()
to the specified value.Set the property corresponding toNetworkInstance.getInterInstancePolicies()
to the specified value.Set the property corresponding toNetworkInstance.getName()
to the specified value.setProtocols
(Protocols value) Set the property corresponding toNetworkInstance.getProtocols()
to the specified value.Set the property corresponding toNetworkInstance.getState()
to the specified value.Set the property corresponding toNetworkInstance.getTableConnections()
to the specified value.Set the property corresponding toNetworkInstance.getTables()
to the specified value.Set the key value corresponding toNetworkInstance.key()
to the specified value.
-
Constructor Details
-
NetworkInstanceBuilder
public NetworkInstanceBuilder()Construct an empty builder. -
NetworkInstanceBuilder
Construct a builder initialized with state from specifiedNetworkInstance
.- Parameters:
base
- NetworkInstance from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toNetworkInstance.key()
.- Returns:
- current value
-
getConfig
Return current value associated with the property corresponding toNetworkInstance.getConfig()
.- Returns:
- current value
-
getConnectionPoints
Return current value associated with the property corresponding toNetworkInstance.getConnectionPoints()
.- Returns:
- current value
-
getInterInstancePolicies
Return current value associated with the property corresponding toNetworkInstance.getInterInstancePolicies()
.- Returns:
- current value
-
getInterfaces
Return current value associated with the property corresponding toNetworkInstance.getInterfaces()
.- Returns:
- current value
-
getName
Return current value associated with the property corresponding toNetworkInstance.getName()
.- Returns:
- current value
-
getProtocols
Return current value associated with the property corresponding toNetworkInstance.getProtocols()
.- Returns:
- current value
-
getState
Return current value associated with the property corresponding toNetworkInstance.getState()
.- Returns:
- current value
-
getTableConnections
Return current value associated with the property corresponding toNetworkInstance.getTableConnections()
.- Returns:
- current value
-
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
Set the key value corresponding toNetworkInstance.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toNetworkInstance.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConnectionPoints
Set the property corresponding toNetworkInstance.getConnectionPoints()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInterInstancePolicies
Set the property corresponding toNetworkInstance.getInterInstancePolicies()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInterfaces
Set the property corresponding toNetworkInstance.getInterfaces()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toNetworkInstance.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocols
Set the property corresponding toNetworkInstance.getProtocols()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
Set the property corresponding toNetworkInstance.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableConnections
Set the property corresponding toNetworkInstance.getTableConnections()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTables
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
A newNetworkInstance
instance.- Returns:
- A new
NetworkInstance
instance.
-