Class ReportedRouteBuilder

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

         ReportedRoute createReportedRoute(int fooXyzzy, int barBaz) {
             return new ReportedRouteBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • ReportedRouteBuilder

        public ReportedRouteBuilder()
        Construct an empty builder.
      • ReportedRouteBuilder

        public ReportedRouteBuilder​(ReportedRouteObject arg)
        Construct a new builder initialized from specified ReportedRouteObject.
        arg - ReportedRouteObject from which the builder should be initialized
      • ReportedRouteBuilder

        public ReportedRouteBuilder​(ReportedRoute base)
        Construct a builder initialized with state from specified ReportedRoute.
        base - ReportedRoute from which the builder should be initialized