Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces

Class VpnInterfaceBuilder

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

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

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

    • Constructor Detail

      • VpnInterfaceBuilder

        public VpnInterfaceBuilder()

      • VpnInterfaceBuilder

        public VpnInterfaceBuilder​(VpnInterface 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.NetworkAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()

      • getName

        public java.lang.String getName()

      • getNetworkId

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

      • getSegmentationId

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

      • getVpnInstanceNames

        public java.util.List<VpnInstanceNames> getVpnInstanceNames()

      • isExternal

        public java.lang.Boolean isExternal()

      • isRouterInterface

        public java.lang.Boolean isRouterInterface()

      • augmentation

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

      • setDpnId

        public VpnInterfaceBuilder setDpnId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDpnId

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

      • setNetworkId

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

      • setSegmentationId

        public VpnInterfaceBuilder setSegmentationId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSegmentationId

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

      • setRouterInterface

        public VpnInterfaceBuilder setRouterInterface​(java.lang.Boolean value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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