Class VpnMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnMap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnMap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnMapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnMap>
Class that buildsVpnMapBuilder
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:
VpnMapBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnMapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnMapBuilder, 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:
VpnMapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnMapBuilder()
VpnMapBuilder(VpnMap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnMap
build()
java.lang.String
getName()
java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>
getNetworkIds()
java.util.Map<RouterIdsKey,RouterIds>
getRouterIds()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getVpnId()
VpnMapKey
key()
VpnMapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap>> augmentationType)
Remove an augmentation from this builder's product.VpnMapBuilder
setName(java.lang.String value)
VpnMapBuilder
setNetworkIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
VpnMapBuilder
setRouterIds(java.util.List<RouterIds> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRouterIds(Map)
instead.VpnMapBuilder
setRouterIds(java.util.Map<RouterIdsKey,RouterIds> values)
VpnMapBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnMapBuilder
setVpnId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnMapBuilder
withKey(VpnMapKey key)
-
-
-
Constructor Detail
-
VpnMapBuilder
public VpnMapBuilder()
-
VpnMapBuilder
public VpnMapBuilder(VpnMap base)
-
-
Method Detail
-
key
public VpnMapKey key()
-
getName
public java.lang.String getName()
-
getNetworkIds
public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()
-
getRouterIds
public java.util.Map<RouterIdsKey,RouterIds> getRouterIds()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getVpnId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnMapBuilder withKey(VpnMapKey key)
-
setName
public VpnMapBuilder setName(java.lang.String value)
-
setNetworkIds
public VpnMapBuilder setNetworkIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
setRouterIds
public VpnMapBuilder setRouterIds(java.util.Map<RouterIdsKey,RouterIds> values)
-
setRouterIds
@Deprecated(forRemoval=true) public VpnMapBuilder setRouterIds(java.util.List<RouterIds> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRouterIds(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setTenantId
public VpnMapBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setVpnId
public VpnMapBuilder setVpnId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public VpnMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap> 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 VpnMapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnMap>> 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
-
-