Class VpnInstanceNamesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.vpn._interface.VpnInstanceNamesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnInstanceNames>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstanceNames,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VpnInstanceNamesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnInstanceNames>
Class that buildsVpnInstanceNamesBuilder
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:
VpnInstanceNamesBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnInstanceNamesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnInstanceNamesBuilder, 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:
VpnInstanceNamesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnInstanceNamesBuilder()
VpnInstanceNamesBuilder(VpnInstanceNames base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnInstanceNamesBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnInstanceNames
build()
VpnInstanceNames.AssociatedSubnetType
getAssociatedSubnetType()
java.lang.String
getVpnName()
VpnInstanceNamesKey
key()
VpnInstanceNamesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>> augmentationType)
VpnInstanceNamesBuilder
setAssociatedSubnetType(VpnInstanceNames.AssociatedSubnetType value)
VpnInstanceNamesBuilder
setVpnName(java.lang.String value)
VpnInstanceNamesBuilder
withKey(VpnInstanceNamesKey key)
-
-
-
Constructor Detail
-
VpnInstanceNamesBuilder
public VpnInstanceNamesBuilder()
-
VpnInstanceNamesBuilder
public VpnInstanceNamesBuilder(VpnInstanceNames base)
-
-
Method Detail
-
key
public VpnInstanceNamesKey key()
-
getAssociatedSubnetType
public VpnInstanceNames.AssociatedSubnetType getAssociatedSubnetType()
-
getVpnName
public java.lang.String getVpnName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnInstanceNamesBuilder withKey(VpnInstanceNamesKey key)
-
setAssociatedSubnetType
public VpnInstanceNamesBuilder setAssociatedSubnetType(VpnInstanceNames.AssociatedSubnetType value)
-
setVpnName
public VpnInstanceNamesBuilder setVpnName(java.lang.String value)
-
addAugmentation
public VpnInstanceNamesBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames> augmentationValue)
-
removeAugmentation
public VpnInstanceNamesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceNames>> augmentationType)
-
build
public VpnInstanceNames build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnInstanceNames>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstanceNames,java.lang.IllegalArgumentException>
-
-