Class VpnIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnIds>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnIds,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnIdsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnIds>
Class that buildsVpnIdsBuilder
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:
VpnIdsBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnIdsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnIdsBuilder, 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:
VpnIdsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnIdsBuilder()
VpnIdsBuilder(VpnIds base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnIdsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnIds
build()
java.util.Map<PrefixesKey,Prefixes>
getPrefixes()
org.opendaylight.yangtools.yang.common.Uint32
getVpnId()
VpnIdsKey
key()
VpnIdsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds>> augmentationType)
Remove an augmentation from this builder's product.VpnIdsBuilder
setPrefixes(java.util.List<Prefixes> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrefixes(Map)
instead.VpnIdsBuilder
setPrefixes(java.util.Map<PrefixesKey,Prefixes> values)
VpnIdsBuilder
setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnId(Uint32)
instead.VpnIdsBuilder
setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnIdsBuilder
withKey(VpnIdsKey key)
-
-
-
Constructor Detail
-
VpnIdsBuilder
public VpnIdsBuilder()
-
VpnIdsBuilder
public VpnIdsBuilder(VpnIds base)
-
-
Method Detail
-
key
public VpnIdsKey key()
-
getPrefixes
public java.util.Map<PrefixesKey,Prefixes> getPrefixes()
-
getVpnId
public org.opendaylight.yangtools.yang.common.Uint32 getVpnId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnIdsBuilder withKey(VpnIdsKey key)
-
setPrefixes
public VpnIdsBuilder setPrefixes(java.util.Map<PrefixesKey,Prefixes> values)
-
setPrefixes
@Deprecated(forRemoval=true) public VpnIdsBuilder setPrefixes(java.util.List<Prefixes> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrefixes(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
-
setVpnId
public VpnIdsBuilder setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVpnId
@Deprecated(forRemoval=true) public VpnIdsBuilder setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public VpnIdsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds> 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 VpnIdsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIds>> 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
-
-