Class SubmitTriggerSyncOutputBuilder


  • @Generated("mdsal-binding-generator")
    public class SubmitTriggerSyncOutputBuilder
    extends Object
    Class that builds SubmitTriggerSyncOutput 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:

       
         SubmitTriggerSyncOutput createSubmitTriggerSyncOutput(int fooXyzzy, int barBaz) {
             return new SubmitTriggerSyncOutputBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • SubmitTriggerSyncOutputBuilder

        public SubmitTriggerSyncOutputBuilder()
        Construct an empty builder.
      • SubmitTriggerSyncOutputBuilder

        public SubmitTriggerSyncOutputBuilder​(TopologyInstructionOutput arg)
        Construct a new builder initialized from specified TopologyInstructionOutput.
        Parameters:
        arg - TopologyInstructionOutput from which the builder should be initialized
      • SubmitTriggerSyncOutputBuilder

        public SubmitTriggerSyncOutputBuilder​(SubmitInstructionOutput arg)
        Construct a new builder initialized from specified SubmitInstructionOutput.
        Parameters:
        arg - SubmitInstructionOutput from which the builder should be initialized
      • SubmitTriggerSyncOutputBuilder

        public SubmitTriggerSyncOutputBuilder​(SubmitTriggerSyncOutput base)
        Construct a builder initialized with state from specified SubmitTriggerSyncOutput.
        Parameters:
        base - SubmitTriggerSyncOutput from which the builder should be initialized