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

Class Lsp1Builder

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

   
     Lsp1 createLsp1(int fooXyzzy, int barBaz) {
         return new Lsp1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Lsp1Builder

      public Lsp1Builder()
      Construct an empty builder.

    • Lsp1Builder

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

  • Method Details

    • getCreate

      public Boolean getCreate()
      Return current value associated with the property corresponding to Lsp1.getCreate().
      Returns:
      current value

    • setCreate

      public Lsp1Builder setCreate(Boolean value)
      Set the property corresponding to Lsp1.getCreate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull Lsp1 build()
      A new Lsp1 instance.
      Returns:
      A new Lsp1 instance.