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

     RouteSelectionOptions createRouteSelectionOptions(int fooXyzzy, int barBaz) {
         return new RouteSelectionOptionsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

This pattern is supported by the immutable nature of RouteSelectionOptions, 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 Details

    • RouteSelectionOptionsBuilder

      public RouteSelectionOptionsBuilder()
      Construct an empty builder.
    • RouteSelectionOptionsBuilder

      public RouteSelectionOptionsBuilder(RouteSelectionOptions base)
      Construct a builder initialized with state from specified RouteSelectionOptions.
      base - RouteSelectionOptions from which the builder should be initialized
  • Method Details