Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data
Class VpnInterfaceOpDataEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnInterfaceOpDataEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterfaceOpDataEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VpnInterfaceOpDataEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnInterfaceOpDataEntry>
Class that buildsVpnInterfaceOpDataEntryBuilder
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:
VpnInterfaceOpDataEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnInterfaceOpDataEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnInterfaceOpDataEntryBuilder, 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:
VpnInterfaceOpDataEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnInterfaceOpDataEntryBuilder()
VpnInterfaceOpDataEntryBuilder(VpnInterfaceOpDataEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnInterfaceOpDataEntryBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnInterfaceOpDataEntry
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
java.lang.String
getGatewayIpAddress()
java.lang.String
getGatewayMacAddress()
org.opendaylight.yangtools.yang.common.Uint32
getLportTag()
java.lang.String
getName()
java.lang.String
getVpnInstanceName()
VpnInterfaceOpDataEntry.VpnInterfaceState
getVpnInterfaceState()
java.lang.Boolean
isRouterInterface()
VpnInterfaceOpDataEntryKey
key()
VpnInterfaceOpDataEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>> augmentationType)
VpnInterfaceOpDataEntryBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpnId(Uint64)} instead.VpnInterfaceOpDataEntryBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
VpnInterfaceOpDataEntryBuilder
setGatewayIpAddress(java.lang.String value)
VpnInterfaceOpDataEntryBuilder
setGatewayMacAddress(java.lang.String value)
VpnInterfaceOpDataEntryBuilder
setLportTag(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setLportTag(Uint32)} instead.VpnInterfaceOpDataEntryBuilder
setLportTag(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnInterfaceOpDataEntryBuilder
setName(java.lang.String value)
VpnInterfaceOpDataEntryBuilder
setRouterInterface(java.lang.Boolean value)
VpnInterfaceOpDataEntryBuilder
setVpnInstanceName(java.lang.String value)
VpnInterfaceOpDataEntryBuilder
setVpnInterfaceState(VpnInterfaceOpDataEntry.VpnInterfaceState value)
VpnInterfaceOpDataEntryBuilder
withKey(VpnInterfaceOpDataEntryKey key)
-
-
-
Constructor Detail
-
VpnInterfaceOpDataEntryBuilder
public VpnInterfaceOpDataEntryBuilder()
-
VpnInterfaceOpDataEntryBuilder
public VpnInterfaceOpDataEntryBuilder(VpnInterfaceOpDataEntry base)
-
-
Method Detail
-
key
public VpnInterfaceOpDataEntryKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getGatewayIpAddress
public java.lang.String getGatewayIpAddress()
-
getGatewayMacAddress
public java.lang.String getGatewayMacAddress()
-
getLportTag
public org.opendaylight.yangtools.yang.common.Uint32 getLportTag()
-
getName
public java.lang.String getName()
-
getVpnInstanceName
public java.lang.String getVpnInstanceName()
-
getVpnInterfaceState
public VpnInterfaceOpDataEntry.VpnInterfaceState getVpnInterfaceState()
-
isRouterInterface
public java.lang.Boolean isRouterInterface()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnInterfaceOpDataEntryBuilder withKey(VpnInterfaceOpDataEntryKey key)
-
setDpnId
public VpnInterfaceOpDataEntryBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public VpnInterfaceOpDataEntryBuilder setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpnId(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setGatewayIpAddress
public VpnInterfaceOpDataEntryBuilder setGatewayIpAddress(java.lang.String value)
-
setGatewayMacAddress
public VpnInterfaceOpDataEntryBuilder setGatewayMacAddress(java.lang.String value)
-
setLportTag
public VpnInterfaceOpDataEntryBuilder setLportTag(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLportTag
@Deprecated(forRemoval=true) public VpnInterfaceOpDataEntryBuilder setLportTag(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setLportTag(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public VpnInterfaceOpDataEntryBuilder setName(java.lang.String value)
-
setVpnInstanceName
public VpnInterfaceOpDataEntryBuilder setVpnInstanceName(java.lang.String value)
-
setVpnInterfaceState
public VpnInterfaceOpDataEntryBuilder setVpnInterfaceState(VpnInterfaceOpDataEntry.VpnInterfaceState value)
-
setRouterInterface
public VpnInterfaceOpDataEntryBuilder setRouterInterface(java.lang.Boolean value)
-
addAugmentation
public VpnInterfaceOpDataEntryBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry> augmentationValue)
-
removeAugmentation
public VpnInterfaceOpDataEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaceOpDataEntry>> augmentationType)
-
build
public VpnInterfaceOpDataEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnInterfaceOpDataEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterfaceOpDataEntry,java.lang.IllegalArgumentException>
-
-