Class StatisticsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Statistics>, org.opendaylight.yangtools.concepts.CheckedBuilder<Statistics,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class StatisticsBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<Statistics>
    Class that builds StatisticsBuilder 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:

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

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

      • StatisticsBuilder

        public StatisticsBuilder()
      • StatisticsBuilder

        public StatisticsBuilder​(Statistics base)
    • Method Detail

      • getPrefixHitCount

        public org.opendaylight.yangtools.yang.common.Uint32 getPrefixHitCount()
      • augmentation

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

        public StatisticsBuilder setPrefixHitCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setPrefixHitCount

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

        public StatisticsBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statistics>> augmentationType,
                                                 org.opendaylight.yangtools.yang.binding.Augmentation<Statistics> augmentationValue)
      • removeAugmentation

        public StatisticsBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statistics>> augmentationType)
      • build

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