Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map

Class ElanTagNameBuilder

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

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

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

    • Constructor Detail

      • ElanTagNameBuilder

        public ElanTagNameBuilder()

      • ElanTagNameBuilder

        public ElanTagNameBuilder​(ElanTagName base)

    • Method Detail

      • getElanTag

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

      • getName

        public java.lang.String getName()

      • augmentation

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

      • setElanTag

        public ElanTagNameBuilder setElanTag​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setElanTag

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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