Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.af.config

Class PrefixLimitBuilder

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

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

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

    • Constructor Detail

      • PrefixLimitBuilder

        public PrefixLimitBuilder()

      • PrefixLimitBuilder

        public PrefixLimitBuilder​(PrefixLimit base)

    • Method Detail

      • getPrefixLimitNumber

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

      • augmentation

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

      • setPrefixLimitNumber

        public PrefixLimitBuilder setPrefixLimitNumber​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setPrefixLimitNumber

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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