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

Class CreateIdPoolInputBuilder

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

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

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

    • Constructor Detail

      • CreateIdPoolInputBuilder

        public CreateIdPoolInputBuilder()

      • CreateIdPoolInputBuilder

        public CreateIdPoolInputBuilder​(CreateIdPoolInput base)

    • Method Detail

      • getHigh

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

      • getLow

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

      • getPoolName

        public java.lang.String getPoolName()

      • augmentation

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

      • setHigh

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

      • setLow

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

      • build

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