Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911

Class VpnInstanceToVpnIdBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnIdBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<VpnInstanceToVpnId>, org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstanceToVpnId,java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class VpnInstanceToVpnIdBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<VpnInstanceToVpnId>

Class that builds VpnInstanceToVpnIdBuilder 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:

   
     VpnInstanceToVpnIdBuilder createTarget(int fooXyzzy, int barBaz) {
         return new VpnInstanceToVpnIdBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of VpnInstanceToVpnIdBuilder, 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:

VpnInstanceToVpnIdBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
VpnInstanceToVpnIdBuilder()
VpnInstanceToVpnIdBuilder(VpnInstanceToVpnId base)

Method Summary

Modifier and Type	Method	Description
VpnInstanceToVpnIdBuilder	addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> E$$	augmentation(java.lang.Class<E$$> augmentationType)
VpnInstanceToVpnId	build()
java.util.List<VpnInstance>	getVpnInstance()
VpnInstanceToVpnIdBuilder	removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> augmentationType)
VpnInstanceToVpnIdBuilder	setVpnInstance(java.util.List<VpnInstance> values)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VpnInstanceToVpnIdBuilder

public VpnInstanceToVpnIdBuilder()

VpnInstanceToVpnIdBuilder

public VpnInstanceToVpnIdBuilder(VpnInstanceToVpnId base)

Method Detail

getVpnInstance

public java.util.List<VpnInstance> getVpnInstance()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> E$$ augmentation(java.lang.Class<E$$> augmentationType)

setVpnInstance

public VpnInstanceToVpnIdBuilder setVpnInstance(java.util.List<VpnInstance> values)

addAugmentation

public VpnInstanceToVpnIdBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> augmentationType,
                                                 org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId> augmentationValue)

removeAugmentation

public VpnInstanceToVpnIdBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstanceToVpnId>> augmentationType)

build

public VpnInstanceToVpnId build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<VpnInstanceToVpnId>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstanceToVpnId,java.lang.IllegalArgumentException>