Class L2vpnBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<L2vpn>, org.opendaylight.yangtools.concepts.CheckedBuilder<L2vpn,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

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

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

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

      • L2vpnBuilder

        public L2vpnBuilder()
      • L2vpnBuilder

        public L2vpnBuilder​(L2vpn base)
    • Method Detail

      • getEvpn

        public Evpn getEvpn()
      • getVpls

        public Vpls getVpls()
      • augmentation

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

        public L2vpnBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2vpn>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<L2vpn> augmentationValue)
      • removeAugmentation

        public L2vpnBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2vpn>> augmentationType)
      • build

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