Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state

Class ElanBuilder

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

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

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

    • Constructor Detail

      • ElanBuilder

        public ElanBuilder()

      • ElanBuilder

        public ElanBuilder​(Elan base)

    • Method Detail

      • getElanInterfaces

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

      • getName

        public java.lang.String getName()

      • augmentation

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

      • setElanInterfaces

        public ElanBuilder setElanInterfaces​(java.util.List<java.lang.String> values)

      • setName

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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