Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id

Class 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>
    public class VpnInstanceBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<VpnInstance>
    Class that builds VpnInstanceBuilder 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 Detail

      • VpnInstanceBuilder

        public VpnInstanceBuilder()

      • VpnInstanceBuilder

        public VpnInstanceBuilder​(VpnInstance base)

    • Method Detail

      • 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)

      • 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.
        Use {#link setVpnId(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setVpnInstanceName

        public VpnInstanceBuilder setVpnInstanceName​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

        public VpnInstanceBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnInstance>> augmentationType)

      • build

        public VpnInstance build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<VpnInstance>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<VpnInstance,​java.lang.IllegalArgumentException>