Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case.success

Class PathsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case.success.PathsBuilder
@Generated("mdsal-binding-generator") public class PathsBuilder extends Object
Class that builds Paths 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: 

   
     Paths createPaths(int fooXyzzy, int barBaz) {
         return new PathsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PathsBuilder

      public PathsBuilder()
      Construct an empty builder.

    • PathsBuilder

      public PathsBuilder(PathDefinition arg)
      Construct a new builder initialized from specified PathDefinition.
      Parameters:
      arg - PathDefinition from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(ExplicitRouteObject arg)
      Construct a new builder initialized from specified ExplicitRouteObject.
      Parameters:
      arg - ExplicitRouteObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(LspAttributes arg)
      Construct a new builder initialized from specified LspAttributes.
      Parameters:
      arg - LspAttributes from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(LspaObject arg)
      Construct a new builder initialized from specified LspaObject.
      Parameters:
      arg - LspaObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(BandwidthObject arg)
      Construct a new builder initialized from specified BandwidthObject.
      Parameters:
      arg - BandwidthObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(ReoptimizationBandwidthObject arg)
      Construct a new builder initialized from specified ReoptimizationBandwidthObject.
      Parameters:
      arg - ReoptimizationBandwidthObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(IncludeRouteObject arg)
      Construct a new builder initialized from specified IncludeRouteObject.
      Parameters:
      arg - IncludeRouteObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(ReportedRouteObject arg)
      Construct a new builder initialized from specified ReportedRouteObject.
      Parameters:
      arg - ReportedRouteObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(ExcludeRouteObject arg)
      Construct a new builder initialized from specified ExcludeRouteObject.
      Parameters:
      arg - ExcludeRouteObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(OfObject arg)
      Construct a new builder initialized from specified OfObject.
      Parameters:
      arg - OfObject from which the builder should be initialized

    • PathsBuilder

      public PathsBuilder(ClasstypeObject arg)
      Construct a new builder initialized from specified ClasstypeObject.
      Parameters:
      arg - ClasstypeObject from which the builder should be initialized

    • PathsBuilder

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

  • Method Details