Class VpnBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Vpn>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Vpn,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VpnBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Vpn>
Class that buildsVpnBuilder
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:
VpnBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnBuilder, 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:
VpnBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnBuilder()
VpnBuilder(Vpn base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vpn> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Vpn
build()
java.util.List<ExtraRoutes>
getExtraRoutes()
java.lang.String
getVpnName()
VpnKey
key()
VpnBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>> augmentationType)
VpnBuilder
setExtraRoutes(java.util.List<ExtraRoutes> values)
VpnBuilder
setVpnName(java.lang.String value)
VpnBuilder
withKey(VpnKey key)
-
-
-
Constructor Detail
-
VpnBuilder
public VpnBuilder()
-
VpnBuilder
public VpnBuilder(Vpn base)
-
-
Method Detail
-
key
public VpnKey key()
-
getExtraRoutes
public java.util.List<ExtraRoutes> getExtraRoutes()
-
getVpnName
public java.lang.String getVpnName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnBuilder withKey(VpnKey key)
-
setExtraRoutes
public VpnBuilder setExtraRoutes(java.util.List<ExtraRoutes> values)
-
setVpnName
public VpnBuilder setVpnName(java.lang.String value)
-
addAugmentation
public VpnBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vpn> augmentationValue)
-
removeAugmentation
public VpnBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpn>> augmentationType)
-
-