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

Class Srp1Builder

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

   
     Srp1 createSrp1(int fooXyzzy, int barBaz) {
         return new Srp1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Srp1Builder

      public Srp1Builder()
      Construct an empty builder.

    • Srp1Builder

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

  • Method Details

    • getRemove

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

    • setRemove

      public Srp1Builder setRemove(Boolean value)
      Set the property corresponding to Srp1.getRemove() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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