Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.lan.auto.generated._case

Class LanAutoGeneratedBuilder

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

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

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

    • Constructor Detail

      • LanAutoGeneratedBuilder

        public LanAutoGeneratedBuilder()

      • LanAutoGeneratedBuilder

        public LanAutoGeneratedBuilder​(LanAutoGenerated base)

    • Method Detail

      • getRootBridgeMacAddress

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

      • getRootBridgePriority

        public org.opendaylight.yangtools.yang.common.Uint16 getRootBridgePriority()

      • augmentation

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

      • setRootBridgeMacAddress

        public LanAutoGeneratedBuilder setRootBridgeMacAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

      • setRootBridgePriority

        public LanAutoGeneratedBuilder setRootBridgePriority​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setRootBridgePriority

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