java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder

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

   
     L3vpnMcastRoute createL3vpnMcastRoute(int fooXyzzy, int barBaz) {
         return new L3vpnMcastRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • L3vpnMcastRouteBuilder

      public L3vpnMcastRouteBuilder()
      Construct an empty builder.
    • L3vpnMcastRouteBuilder

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

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

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

      public L3vpnMcastRouteBuilder(L3vpnMcastRoute arg)
      Construct a new builder initialized from specified L3vpnMcastRoute.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoute from which the builder should be initialized
    • L3vpnMcastRouteBuilder

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

      public L3vpnMcastRouteBuilder(L3vpnMcastRoute base)
      Construct a builder initialized with state from specified L3vpnMcastRoute.
      Parameters:
      base - L3vpnMcastRoute from which the builder should be initialized
  • Method Details