Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329

Class Peer1Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.Peer1Builder
@Generated("mdsal-binding-generator") public class Peer1Builder extends Object
Class that builds Peer1 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: 

   
     Peer1 createPeer1(int fooXyzzy, int barBaz) {
         return new Peer1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Peer1Builder

      public Peer1Builder()
      Construct an empty builder.

    • Peer1Builder

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

  • Method Details

    • build

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