Class State9Builder


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

       
         State9 createState9(int fooXyzzy, int barBaz) {
             return new State9Builder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • State9Builder

        public State9Builder()
        Construct an empty builder.
      • State9Builder

        public State9Builder​(State9 base)
        Construct a builder initialized with state from specified State9.
        Parameters:
        base - State9 from which the builder should be initialized
    • Method Detail

      • getMessages

        public Messages getMessages()
        Return current value associated with the property corresponding to State9.getMessages().
        Returns:
        current value
      • getQueues

        public Queues getQueues()
        Return current value associated with the property corresponding to State9.getQueues().
        Returns:
        current value
      • setQueues

        public State9Builder setQueues​(Queues value)
        Set the property corresponding to State9.getQueues() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • build

        public @NonNull State9 build()
        A new State9 instance.
        Returns:
        A new State9 instance.