Class VpnToDpnListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnToDpnList>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnToDpnList,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnToDpnListBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnToDpnList>
Class that buildsVpnToDpnListBuilder
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:
VpnToDpnListBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnToDpnListBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnToDpnListBuilder, 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:
VpnToDpnListBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnToDpnListBuilder()
VpnToDpnListBuilder(VpnToDpnList base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnToDpnListBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnToDpnList
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
VpnToDpnList.DpnState
getDpnState()
java.util.Map<IpAddressesKey,IpAddresses>
getIpAddresses()
java.util.Map<VpnInterfacesKey,VpnInterfaces>
getVpnInterfaces()
VpnToDpnListKey
key()
VpnToDpnListBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList>> augmentationType)
Remove an augmentation from this builder's product.VpnToDpnListBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.VpnToDpnListBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
VpnToDpnListBuilder
setDpnState(VpnToDpnList.DpnState value)
VpnToDpnListBuilder
setIpAddresses(java.util.List<IpAddresses> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpAddresses(Map)
instead.VpnToDpnListBuilder
setIpAddresses(java.util.Map<IpAddressesKey,IpAddresses> values)
VpnToDpnListBuilder
setVpnInterfaces(java.util.List<VpnInterfaces> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnInterfaces(Map)
instead.VpnToDpnListBuilder
setVpnInterfaces(java.util.Map<VpnInterfacesKey,VpnInterfaces> values)
VpnToDpnListBuilder
withKey(VpnToDpnListKey key)
-
-
-
Constructor Detail
-
VpnToDpnListBuilder
public VpnToDpnListBuilder()
-
VpnToDpnListBuilder
public VpnToDpnListBuilder(VpnToDpnList base)
-
-
Method Detail
-
key
public VpnToDpnListKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getDpnState
public VpnToDpnList.DpnState getDpnState()
-
getIpAddresses
public java.util.Map<IpAddressesKey,IpAddresses> getIpAddresses()
-
getVpnInterfaces
public java.util.Map<VpnInterfacesKey,VpnInterfaces> getVpnInterfaces()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnToDpnListBuilder withKey(VpnToDpnListKey key)
-
setDpnId
public VpnToDpnListBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public VpnToDpnListBuilder setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDpnState
public VpnToDpnListBuilder setDpnState(VpnToDpnList.DpnState value)
-
setIpAddresses
public VpnToDpnListBuilder setIpAddresses(java.util.Map<IpAddressesKey,IpAddresses> values)
-
setIpAddresses
@Deprecated(forRemoval=true) public VpnToDpnListBuilder setIpAddresses(java.util.List<IpAddresses> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpAddresses(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
-
setVpnInterfaces
public VpnToDpnListBuilder setVpnInterfaces(java.util.Map<VpnInterfacesKey,VpnInterfaces> values)
-
setVpnInterfaces
@Deprecated(forRemoval=true) public VpnToDpnListBuilder setVpnInterfaces(java.util.List<VpnInterfaces> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnInterfaces(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
-
addAugmentation
public VpnToDpnListBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList> 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 VpnToDpnListBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnToDpnList>> 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 VpnToDpnList build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnToDpnList>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnToDpnList,java.lang.IllegalArgumentException>
-
-