Class MatchNeighborSetBuilder

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

         MatchNeighborSet createMatchNeighborSet(int fooXyzzy, int barBaz) {
             return new MatchNeighborSetBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • MatchNeighborSetBuilder

        public MatchNeighborSetBuilder()
        Construct an empty builder.
      • MatchNeighborSetBuilder

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