Class NetworkInstanceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NetworkInstance>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NetworkInstance,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NetworkInstanceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NetworkInstance>
Class that buildsNetworkInstanceBuilder
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:
NetworkInstanceBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkInstanceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkInstanceBuilder, 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 oportunities, 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:
NetworkInstanceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkInstanceBuilder()
NetworkInstanceBuilder(NetworkInstance base)
-
Method Summary
-
-
-
Constructor Detail
-
NetworkInstanceBuilder
public NetworkInstanceBuilder()
-
NetworkInstanceBuilder
public NetworkInstanceBuilder(NetworkInstance base)
-
-
Method Detail
-
key
public NetworkInstanceKey key()
-
getConfig
public Config getConfig()
-
getConnectionPoints
public ConnectionPoints getConnectionPoints()
-
getInterInstancePolicies
public InterInstancePolicies getInterInstancePolicies()
-
getInterfaces
public Interfaces getInterfaces()
-
getName
public String getName()
-
getProtocols
public Protocols getProtocols()
-
getState
public State getState()
-
getTableConnections
public TableConnections getTableConnections()
-
getTables
public Tables getTables()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NetworkInstanceBuilder withKey(NetworkInstanceKey key)
-
setConfig
public NetworkInstanceBuilder setConfig(Config value)
-
setConnectionPoints
public NetworkInstanceBuilder setConnectionPoints(ConnectionPoints value)
-
setInterInstancePolicies
public NetworkInstanceBuilder setInterInstancePolicies(InterInstancePolicies value)
-
setInterfaces
public NetworkInstanceBuilder setInterfaces(Interfaces value)
-
setName
public NetworkInstanceBuilder setName(String value)
-
setProtocols
public NetworkInstanceBuilder setProtocols(Protocols value)
-
setState
public NetworkInstanceBuilder setState(State value)
-
setTableConnections
public NetworkInstanceBuilder setTableConnections(TableConnections value)
-
setTables
public NetworkInstanceBuilder setTables(Tables value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public NetworkInstanceBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstance> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 NetworkInstance build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NetworkInstance>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NetworkInstance,IllegalArgumentException>
-
-