Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.ethernet.tag.id

Class EthernetTagIdBuilder

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

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

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

    • Constructor Detail

      • EthernetTagIdBuilder

        public EthernetTagIdBuilder()

      • EthernetTagIdBuilder

        public EthernetTagIdBuilder​(EthernetTagId base)

    • Method Detail

      • getVlanId

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

      • augmentation

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

      • setVlanId

        public EthernetTagIdBuilder setVlanId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setVlanId

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

      • addAugmentation

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