Class ResultBuilder

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

    public class ResultBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Result>
    Class that builds ResultBuilder 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:

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

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

      • ResultBuilder

        public ResultBuilder()
      • ResultBuilder

        public ResultBuilder​(Result base)
    • Method Detail

      • getCount

        public org.opendaylight.yangtools.yang.common.Uint32 getCount()
      • getDuration

        public org.opendaylight.yangtools.yang.common.Uint32 getDuration()
      • getRate

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

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> E$$ augmentation​(Class<E$$> augmentationType)
      • setCount

        public ResultBuilder setCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setCount

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

        public ResultBuilder setDuration​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setDuration

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

        public ResultBuilder setRate​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setRate

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

        public ResultBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> augmentationType,
                                             org.opendaylight.yangtools.yang.binding.Augmentation<Result> augmentationValue)
      • removeAugmentation

        public ResultBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> augmentationType)
      • build

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