Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.bgpvpns.rev150903.bgpvpns.attributes.bgpvpns

Class BgpvpnBuilder

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

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

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

    • Constructor Detail

      • BgpvpnBuilder

        public BgpvpnBuilder()

      • BgpvpnBuilder

        public BgpvpnBuilder​(Bgpvpn 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.neutron.bgpvpns.rev150903.BgpvpnAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getExportTargets

        public List<String> getExportTargets()

      • getImportTargets

        public List<String> getImportTargets()

      • getName

        public String getName()

      • getNetworks

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

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getRouteDistinguishers

        public List<String> getRouteDistinguishers()

      • getRouteTargets

        public List<String> getRouteTargets()

      • getRouters

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

      • getStatus

        public String getStatus()

      • getTechnique

        public String getTechnique()

      • getTenantId

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

      • getUuid

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

      • getVni

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

      • isAdminStateUp

        public Boolean isAdminStateUp()

      • isAutoAggregate

        public Boolean isAutoAggregate()

      • augmentation

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

      • setNetworks

        public BgpvpnBuilder setNetworks​(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)

      • setRouters

        public BgpvpnBuilder setRouters​(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)

      • setTenantId

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

      • setUuid

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

      • setVni

        public BgpvpnBuilder setVni​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setVni

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

      • addAugmentation

        public BgpvpnBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgpvpn>> augmentationType,
                                     org.opendaylight.yangtools.yang.binding.Augmentation<Bgpvpn> augmentationValue)

      • removeAugmentation

        public BgpvpnBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgpvpn>> augmentationType)

      • build

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