Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
Class VpnInstanceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnInstance>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstance,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnInstanceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnInstance>
Class that buildsVpnInstanceBuilder
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:
VpnInstanceBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnInstanceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnInstanceBuilder, 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:
VpnInstanceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnInstanceBuilder()
VpnInstanceBuilder(VpnInstance base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnInstanceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnInstance
build()
org.opendaylight.yangtools.yang.common.Uint32
getVpnId()
java.lang.String
getVpnInstanceName()
java.lang.String
getVrfId()
VpnInstanceKey
key()
VpnInstanceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance>> augmentationType)
Remove an augmentation from this builder's product.VpnInstanceBuilder
setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnId(Uint32)
instead.VpnInstanceBuilder
setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnInstanceBuilder
setVpnInstanceName(java.lang.String value)
VpnInstanceBuilder
setVrfId(java.lang.String value)
VpnInstanceBuilder
withKey(VpnInstanceKey key)
-
-
-
Constructor Detail
-
VpnInstanceBuilder
public VpnInstanceBuilder()
-
VpnInstanceBuilder
public VpnInstanceBuilder(VpnInstance base)
-
-
Method Detail
-
key
public VpnInstanceKey key()
-
getVpnId
public org.opendaylight.yangtools.yang.common.Uint32 getVpnId()
-
getVpnInstanceName
public java.lang.String getVpnInstanceName()
-
getVrfId
public java.lang.String getVrfId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnInstanceBuilder withKey(VpnInstanceKey key)
-
setVpnId
public VpnInstanceBuilder setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVpnId
@Deprecated(forRemoval=true) public VpnInstanceBuilder 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
-
setVpnInstanceName
public VpnInstanceBuilder setVpnInstanceName(java.lang.String value)
-
setVrfId
public VpnInstanceBuilder setVrfId(java.lang.String value)
-
addAugmentation
public VpnInstanceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance> 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 VpnInstanceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance>> 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 VpnInstance build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnInstance>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstance,java.lang.IllegalArgumentException>
-
-