Class VpnInterfacesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.subnet.op.data.entry.subnet.to.dpn.VpnInterfacesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnInterfaces>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterfaces,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VpnInterfacesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnInterfaces>
Class that buildsVpnInterfacesBuilder
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:
VpnInterfacesBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnInterfacesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnInterfacesBuilder, 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:
VpnInterfacesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnInterfacesBuilder()
VpnInterfacesBuilder(VpnInterfaces base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnInterfacesBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnInterfaces
build()
java.lang.String
getInterfaceName()
VpnInterfacesKey
key()
VpnInterfacesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>> augmentationType)
VpnInterfacesBuilder
setInterfaceName(java.lang.String value)
VpnInterfacesBuilder
withKey(VpnInterfacesKey key)
-
-
-
Constructor Detail
-
VpnInterfacesBuilder
public VpnInterfacesBuilder()
-
VpnInterfacesBuilder
public VpnInterfacesBuilder(VpnInterfaces base)
-
-
Method Detail
-
key
public VpnInterfacesKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnInterfacesBuilder withKey(VpnInterfacesKey key)
-
setInterfaceName
public VpnInterfacesBuilder setInterfaceName(java.lang.String value)
-
addAugmentation
public VpnInterfacesBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces> augmentationValue)
-
removeAugmentation
public VpnInterfacesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInterfaces>> augmentationType)
-
build
public VpnInterfaces build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnInterfaces>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnInterfaces,java.lang.IllegalArgumentException>
-
-