Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406

Class IfStackedVlanBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<IfStackedVlan>, org.opendaylight.yangtools.concepts.CheckedBuilder<IfStackedVlan,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class IfStackedVlanBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<IfStackedVlan>
    Class that builds IfStackedVlanBuilder 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: 

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

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

    • Constructor Detail

      • IfStackedVlanBuilder

        public IfStackedVlanBuilder()

      • IfStackedVlanBuilder

        public IfStackedVlanBuilder​(IfStackedVlan base)

    • Method Detail

      • getStackedVlanId

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

      • setStackedVlanId

        public IfStackedVlanBuilder setStackedVlanId​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setStackedVlanId

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

      • build

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