Class InitiateEorOutputBuilder

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

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

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

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

      • InitiateEorOutputBuilder

        public InitiateEorOutputBuilder()
      • InitiateEorOutputBuilder

        public InitiateEorOutputBuilder​(InitiateEorOutput base)
    • Method Detail

      • getRetVal

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

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

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

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