Class SetTimeBuilder

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

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

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

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

      • SetTimeBuilder

        public SetTimeBuilder()
      • SetTimeBuilder

        public SetTimeBuilder​(SetTime base)
    • Method Detail

      • getRefreshInterval

        public org.opendaylight.yangtools.yang.common.Uint16 getRefreshInterval()
      • augmentation

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

        public SetTimeBuilder setRefreshInterval​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setRefreshInterval

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

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

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

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