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

Class IdPoolBuilder

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

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

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

    • Constructor Detail

      • IdPoolBuilder

        public IdPoolBuilder()

      • IdPoolBuilder

        public IdPoolBuilder​(IdPool base)

    • Method Detail

      • getBlockSize

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

      • getChildPools

        public java.util.List<ChildPools> getChildPools()

      • getIdEntries

        public java.util.List<IdEntries> getIdEntries()

      • getParentPoolName

        public java.lang.String getParentPoolName()

      • getPoolName

        public java.lang.String getPoolName()

      • augmentation

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

      • setBlockSize

        public IdPoolBuilder setBlockSize​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setBlockSize

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

      • setParentPoolName

        public IdPoolBuilder setParentPoolName​(java.lang.String value)

      • setPoolName

        public IdPoolBuilder setPoolName​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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