Class LabeledUnicastRouteBuilder


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

       
         LabeledUnicastRoute createLabeledUnicastRoute(int fooXyzzy, int barBaz) {
             return new LabeledUnicastRouteBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • LabeledUnicastRouteBuilder

        public LabeledUnicastRouteBuilder()
        Construct an empty builder.
      • LabeledUnicastRouteBuilder

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

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

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

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

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