Class IpPrefixInfoBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.ip.prefix.map.IpPrefixInfoBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpPrefixInfo>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpPrefixInfo,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpPrefixInfoBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpPrefixInfo>
Class that buildsIpPrefixInfoBuilder
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:
IpPrefixInfoBuilder createTarget(int fooXyzzy, int barBaz) { return new IpPrefixInfoBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpPrefixInfoBuilder, 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:
IpPrefixInfoBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpPrefixInfoBuilder()
IpPrefixInfoBuilder(IpPrefixInfo base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpPrefixInfoBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpPrefixInfo
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
org.opendaylight.yangtools.yang.common.Uint32
getElanTag()
IpPrefixInfo.EncapType
getEncapType()
java.lang.Boolean
getIsSubnetRoute()
org.opendaylight.yangtools.yang.common.Uint32
getL2vni()
org.opendaylight.yangtools.yang.common.Uint32
getL3vni()
java.lang.String
getParentPrimaryRd()
org.opendaylight.yangtools.yang.common.Uint32
getParentVpnid()
java.lang.String
getPrefix()
java.util.Map<RoutePathsKey,RoutePaths>
getRoutePaths()
java.util.List<java.lang.String>
getVpnInstanceList()
java.lang.String
getVpnInterfaceName()
java.lang.Boolean
isIsSubnetRoute()
Deprecated, for removal: This API element is subject to removal in a future version.IpPrefixInfoKey
key()
IpPrefixInfoBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo>> augmentationType)
Remove an augmentation from this builder's product.IpPrefixInfoBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.IpPrefixInfoBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
IpPrefixInfoBuilder
setElanTag(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetElanTag(Uint32)
instead.IpPrefixInfoBuilder
setElanTag(org.opendaylight.yangtools.yang.common.Uint32 value)
IpPrefixInfoBuilder
setEncapType(IpPrefixInfo.EncapType value)
IpPrefixInfoBuilder
setIsSubnetRoute(java.lang.Boolean value)
IpPrefixInfoBuilder
setL2vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2vni(Uint32)
instead.IpPrefixInfoBuilder
setL2vni(org.opendaylight.yangtools.yang.common.Uint32 value)
IpPrefixInfoBuilder
setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.IpPrefixInfoBuilder
setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
IpPrefixInfoBuilder
setParentPrimaryRd(java.lang.String value)
IpPrefixInfoBuilder
setParentVpnid(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetParentVpnid(Uint32)
instead.IpPrefixInfoBuilder
setParentVpnid(org.opendaylight.yangtools.yang.common.Uint32 value)
IpPrefixInfoBuilder
setPrefix(java.lang.String value)
IpPrefixInfoBuilder
setRoutePaths(java.util.List<RoutePaths> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRoutePaths(Map)
instead.IpPrefixInfoBuilder
setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
IpPrefixInfoBuilder
setVpnInstanceList(java.util.List<java.lang.String> values)
IpPrefixInfoBuilder
setVpnInterfaceName(java.lang.String value)
IpPrefixInfoBuilder
withKey(IpPrefixInfoKey key)
-
-
-
Constructor Detail
-
IpPrefixInfoBuilder
public IpPrefixInfoBuilder()
-
IpPrefixInfoBuilder
public IpPrefixInfoBuilder(IpPrefixInfo base)
-
-
Method Detail
-
key
public IpPrefixInfoKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getElanTag
public org.opendaylight.yangtools.yang.common.Uint32 getElanTag()
-
getEncapType
public IpPrefixInfo.EncapType getEncapType()
-
getIsSubnetRoute
public java.lang.Boolean getIsSubnetRoute()
-
isIsSubnetRoute
@Deprecated(forRemoval=true) public final java.lang.Boolean isIsSubnetRoute()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getL2vni
public org.opendaylight.yangtools.yang.common.Uint32 getL2vni()
-
getL3vni
public org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
-
getParentPrimaryRd
public java.lang.String getParentPrimaryRd()
-
getParentVpnid
public org.opendaylight.yangtools.yang.common.Uint32 getParentVpnid()
-
getPrefix
public java.lang.String getPrefix()
-
getRoutePaths
public java.util.Map<RoutePathsKey,RoutePaths> getRoutePaths()
-
getVpnInstanceList
public java.util.List<java.lang.String> getVpnInstanceList()
-
getVpnInterfaceName
public java.lang.String getVpnInterfaceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IpPrefixInfoBuilder withKey(IpPrefixInfoKey key)
-
setDpnId
public IpPrefixInfoBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder 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
-
setElanTag
public IpPrefixInfoBuilder setElanTag(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setElanTag
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder setElanTag(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetElanTag(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setEncapType
public IpPrefixInfoBuilder setEncapType(IpPrefixInfo.EncapType value)
-
setIsSubnetRoute
public IpPrefixInfoBuilder setIsSubnetRoute(java.lang.Boolean value)
-
setL2vni
public IpPrefixInfoBuilder setL2vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL2vni
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder setL2vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2vni(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setL3vni
public IpPrefixInfoBuilder setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL3vni
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder 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
-
setParentPrimaryRd
public IpPrefixInfoBuilder setParentPrimaryRd(java.lang.String value)
-
setParentVpnid
public IpPrefixInfoBuilder setParentVpnid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setParentVpnid
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder setParentVpnid(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetParentVpnid(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPrefix
public IpPrefixInfoBuilder setPrefix(java.lang.String value)
-
setRoutePaths
public IpPrefixInfoBuilder setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
-
setRoutePaths
@Deprecated(forRemoval=true) public IpPrefixInfoBuilder setRoutePaths(java.util.List<RoutePaths> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRoutePaths(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
-
setVpnInstanceList
public IpPrefixInfoBuilder setVpnInstanceList(java.util.List<java.lang.String> values)
-
setVpnInterfaceName
public IpPrefixInfoBuilder setVpnInterfaceName(java.lang.String value)
-
addAugmentation
public IpPrefixInfoBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo> 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 IpPrefixInfoBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixInfo>> 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 IpPrefixInfo build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpPrefixInfo>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpPrefixInfo,java.lang.IllegalArgumentException>
-
-