Class NetworkMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NetworkMap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NetworkMap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NetworkMapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<NetworkMap>
Class that buildsNetworkMapBuilder
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:
NetworkMapBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkMapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkMapBuilder, 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:
NetworkMapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkMapBuilder()
NetworkMapBuilder(NetworkMap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NetworkMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
NetworkMap
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getNetworkId()
java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>
getSubnetIdList()
NetworkMapKey
key()
NetworkMapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap>> augmentationType)
Remove an augmentation from this builder's product.NetworkMapBuilder
setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
NetworkMapBuilder
setSubnetIdList(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
NetworkMapBuilder
withKey(NetworkMapKey key)
-
-
-
Constructor Detail
-
NetworkMapBuilder
public NetworkMapBuilder()
-
NetworkMapBuilder
public NetworkMapBuilder(NetworkMap base)
-
-
Method Detail
-
key
public NetworkMapKey key()
-
getNetworkId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
-
getSubnetIdList
public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSubnetIdList()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public NetworkMapBuilder withKey(NetworkMapKey key)
-
setNetworkId
public NetworkMapBuilder setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setSubnetIdList
public NetworkMapBuilder setSubnetIdList(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
addAugmentation
public NetworkMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NetworkMapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetworkMap>> 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 NetworkMap build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NetworkMap>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NetworkMap,java.lang.IllegalArgumentException>
-
-