Class NetworkInstancesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstancesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NetworkInstances>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NetworkInstances,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NetworkInstancesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NetworkInstances>
Class that buildsNetworkInstancesBuilder
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:
NetworkInstancesBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkInstancesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkInstancesBuilder, 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:
NetworkInstancesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkInstancesBuilder()
NetworkInstancesBuilder(NetworkInstances base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NetworkInstancesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>>
E$$augmentation(Class<E$$> augmentationType)
NetworkInstances
build()
List<NetworkInstance>
getNetworkInstance()
NetworkInstancesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType)
NetworkInstancesBuilder
setNetworkInstance(List<NetworkInstance> values)
-
-
-
Constructor Detail
-
NetworkInstancesBuilder
public NetworkInstancesBuilder()
-
NetworkInstancesBuilder
public NetworkInstancesBuilder(NetworkInstances base)
-
-
Method Detail
-
getNetworkInstance
public List<NetworkInstance> getNetworkInstance()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> E$$ augmentation(Class<E$$> augmentationType)
-
setNetworkInstance
public NetworkInstancesBuilder setNetworkInstance(List<NetworkInstance> values)
-
addAugmentation
public NetworkInstancesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances> augmentationValue)
-
removeAugmentation
public NetworkInstancesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkInstances>> augmentationType)
-
build
public NetworkInstances build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NetworkInstances>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NetworkInstances,IllegalArgumentException>
-
-