Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces
Class VpnInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnInterface>
Class that buildsVpnInterfaceBuilder
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:
VpnInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnInterfaceBuilder, 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:
VpnInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnInterfaceBuilder()
VpnInterfaceBuilder(VpnInterface base)
VpnInterfaceBuilder(NetworkAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnInterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnInterface
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
java.lang.Boolean
getExternal()
java.lang.String
getName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getNetworkId()
NetworkAttributes.NetworkType
getNetworkType()
java.lang.Boolean
getRouterInterface()
org.opendaylight.yangtools.yang.common.Uint32
getSegmentationId()
java.util.Map<VpnInstanceNamesKey,VpnInstanceNames>
getVpnInstanceNames()
java.lang.Boolean
isExternal()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isRouterInterface()
Deprecated, for removal: This API element is subject to removal in a future version.VpnInterfaceKey
key()
VpnInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface>> augmentationType)
Remove an augmentation from this builder's product.VpnInterfaceBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.VpnInterfaceBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
VpnInterfaceBuilder
setExternal(java.lang.Boolean value)
VpnInterfaceBuilder
setName(java.lang.String value)
VpnInterfaceBuilder
setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnInterfaceBuilder
setNetworkType(NetworkAttributes.NetworkType value)
VpnInterfaceBuilder
setRouterInterface(java.lang.Boolean value)
VpnInterfaceBuilder
setSegmentationId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentationId(Uint32)
instead.VpnInterfaceBuilder
setSegmentationId(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnInterfaceBuilder
setVpnInstanceNames(java.util.List<VpnInstanceNames> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnInstanceNames(Map)
instead.VpnInterfaceBuilder
setVpnInstanceNames(java.util.Map<VpnInstanceNamesKey,VpnInstanceNames> values)
VpnInterfaceBuilder
withKey(VpnInterfaceKey key)
-
-
-
Constructor Detail
-
VpnInterfaceBuilder
public VpnInterfaceBuilder()
-
VpnInterfaceBuilder
public VpnInterfaceBuilder(NetworkAttributes arg)
-
VpnInterfaceBuilder
public VpnInterfaceBuilder(VpnInterface 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.NetworkAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public VpnInterfaceKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getExternal
public java.lang.Boolean getExternal()
-
isExternal
@Deprecated(forRemoval=true) public final java.lang.Boolean isExternal()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getName
public java.lang.String getName()
-
getNetworkId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
-
getNetworkType
public NetworkAttributes.NetworkType getNetworkType()
-
getRouterInterface
public java.lang.Boolean getRouterInterface()
-
isRouterInterface
@Deprecated(forRemoval=true) public final java.lang.Boolean isRouterInterface()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSegmentationId
public org.opendaylight.yangtools.yang.common.Uint32 getSegmentationId()
-
getVpnInstanceNames
public java.util.Map<VpnInstanceNamesKey,VpnInstanceNames> getVpnInstanceNames()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnInterfaceBuilder withKey(VpnInterfaceKey key)
-
setDpnId
public VpnInterfaceBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public VpnInterfaceBuilder 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
-
setExternal
public VpnInterfaceBuilder setExternal(java.lang.Boolean value)
-
setName
public VpnInterfaceBuilder setName(java.lang.String value)
-
setNetworkId
public VpnInterfaceBuilder setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setNetworkType
public VpnInterfaceBuilder setNetworkType(NetworkAttributes.NetworkType value)
-
setRouterInterface
public VpnInterfaceBuilder setRouterInterface(java.lang.Boolean value)
-
setSegmentationId
public VpnInterfaceBuilder setSegmentationId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSegmentationId
@Deprecated(forRemoval=true) public VpnInterfaceBuilder setSegmentationId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentationId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVpnInstanceNames
public VpnInterfaceBuilder setVpnInstanceNames(java.util.Map<VpnInstanceNamesKey,VpnInstanceNames> values)
-
setVpnInstanceNames
@Deprecated(forRemoval=true) public VpnInterfaceBuilder setVpnInstanceNames(java.util.List<VpnInstanceNames> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnInstanceNames(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 VpnInterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface> 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 VpnInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterface>> 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 VpnInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterface,java.lang.IllegalArgumentException>
-
-