Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps

Class VpnMapBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<VpnMap>, org.opendaylight.yangtools.concepts.CheckedBuilder<VpnMap,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class VpnMapBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<VpnMap>
    Class that builds VpnMapBuilder 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: 

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

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

    • Constructor Detail

      • VpnMapBuilder

        public VpnMapBuilder()

      • VpnMapBuilder

        public VpnMapBuilder​(VpnMap base)

    • Method Detail

      • getName

        public java.lang.String getName()

      • getNetworkIds

        public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()

      • getRouterIds

        public java.util.List<RouterIds> getRouterIds()

      • getTenantId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()

      • getVpnId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()

      • augmentation

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

      • setName

        public VpnMapBuilder setName​(java.lang.String value)

      • setNetworkIds

        public VpnMapBuilder setNetworkIds​(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)

      • setTenantId

        public VpnMapBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setVpnId

        public VpnMapBuilder setVpnId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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