Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720

Class Arguments2Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.Arguments2Builder
@Generated("mdsal-binding-generator") public class Arguments2Builder extends Object
Class that builds Arguments2 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: 

   
     Arguments2 createArguments2(int fooXyzzy, int barBaz) {
         return new Arguments2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Arguments2Builder

      public Arguments2Builder()
      Construct an empty builder.

    • Arguments2Builder

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

    • Arguments2Builder

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

    • Arguments2Builder

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

  • Method Details