Class L3vpnInstancesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.getl3vpn.output.L3vpnInstancesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3vpnInstances>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnInstances,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class L3vpnInstancesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<L3vpnInstances>
Class that buildsL3vpnInstancesBuilder
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:
L3vpnInstancesBuilder createTarget(int fooXyzzy, int barBaz) { return new L3vpnInstancesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3vpnInstancesBuilder, 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:
L3vpnInstancesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3vpnInstancesBuilder()
L3vpnInstancesBuilder(L3vpnInstances base)
L3vpnInstancesBuilder(VpnInstance arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L3vpnInstancesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
L3vpnInstances
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.List<java.lang.String>
getExportRT()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getId()
java.util.List<java.lang.String>
getImportRT()
org.opendaylight.yangtools.yang.common.Uint32
getL3vni()
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.List<java.lang.String>
getRouteDistinguisher()
java.util.Map<RouterIdsKey,RouterIds>
getRouterIds()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
L3vpnInstancesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances>> augmentationType)
Remove an augmentation from this builder's product.L3vpnInstancesBuilder
setExportRT(java.util.List<java.lang.String> values)
L3vpnInstancesBuilder
setId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
L3vpnInstancesBuilder
setImportRT(java.util.List<java.lang.String> values)
L3vpnInstancesBuilder
setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.L3vpnInstancesBuilder
setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
L3vpnInstancesBuilder
setName(java.lang.String value)
L3vpnInstancesBuilder
setNetworkIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
L3vpnInstancesBuilder
setRouteDistinguisher(java.util.List<java.lang.String> values)
L3vpnInstancesBuilder
setRouterIds(java.util.List<RouterIds> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRouterIds(Map)
instead.L3vpnInstancesBuilder
setRouterIds(java.util.Map<RouterIdsKey,RouterIds> values)
L3vpnInstancesBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
-
-
Constructor Detail
-
L3vpnInstancesBuilder
public L3vpnInstancesBuilder()
-
L3vpnInstancesBuilder
public L3vpnInstancesBuilder(VpnInstance arg)
-
L3vpnInstancesBuilder
public L3vpnInstancesBuilder(L3vpnInstances base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnInstance
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getExportRT
public java.util.List<java.lang.String> getExportRT()
-
getId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()
-
getImportRT
public java.util.List<java.lang.String> getImportRT()
-
getL3vni
public org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
-
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()
-
getRouteDistinguisher
public java.util.List<java.lang.String> getRouteDistinguisher()
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setExportRT
public L3vpnInstancesBuilder setExportRT(java.util.List<java.lang.String> values)
-
setId
public L3vpnInstancesBuilder setId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setImportRT
public L3vpnInstancesBuilder setImportRT(java.util.List<java.lang.String> values)
-
setL3vni
public L3vpnInstancesBuilder setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL3vni
@Deprecated(forRemoval=true) public L3vpnInstancesBuilder setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public L3vpnInstancesBuilder setName(java.lang.String value)
-
setNetworkIds
public L3vpnInstancesBuilder setNetworkIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
setRouteDistinguisher
public L3vpnInstancesBuilder setRouteDistinguisher(java.util.List<java.lang.String> values)
-
setRouterIds
public L3vpnInstancesBuilder setRouterIds(java.util.Map<RouterIdsKey,RouterIds> values)
-
setRouterIds
@Deprecated(forRemoval=true) public L3vpnInstancesBuilder 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 L3vpnInstancesBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public L3vpnInstancesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances> 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 L3vpnInstancesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnInstances>> 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 L3vpnInstances build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L3vpnInstances>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnInstances,java.lang.IllegalArgumentException>
-
-