Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.createl3vpn.input

Class L3vpnBuilder

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

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

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

    • Constructor Detail

      • L3vpnBuilder

        public L3vpnBuilder()

      • L3vpnBuilder

        public L3vpnBuilder​(VpnInstance arg)

      • L3vpnBuilder

        public L3vpnBuilder​(L3vpn base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnInstance
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getExportRT

        public java.util.List<java.lang.String> getExportRT()

      • getId

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

      • getImportRT

        public java.util.List<java.lang.String> getImportRT()

      • getL3vni

        public org.opendaylight.yangtools.yang.common.Uint32 getL3vni()

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

      • getRouteDistinguisher

        public java.util.List<java.lang.String> getRouteDistinguisher()

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

      • augmentation

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

      • setExportRT

        public L3vpnBuilder setExportRT​(java.util.List<java.lang.String> values)

      • setId

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

      • setImportRT

        public L3vpnBuilder setImportRT​(java.util.List<java.lang.String> values)

      • setL3vni

        public L3vpnBuilder setL3vni​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setL3vni

        @Deprecated(forRemoval=true)
public L3vpnBuilder setL3vni​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setL3vni(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setName

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

      • setNetworkIds

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

      • setRouteDistinguisher

        public L3vpnBuilder setRouteDistinguisher​(java.util.List<java.lang.String> values)

      • setTenantId

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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