Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021

Class Prefix1Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.Prefix1Builder
@Generated("mdsal-binding-generator") public class Prefix1Builder extends Object
Class that builds Prefix1 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: 

   
     Prefix1 createPrefix1(int fooXyzzy, int barBaz) {
         return new Prefix1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Prefix1Builder

      public Prefix1Builder()
      Construct an empty builder.

    • Prefix1Builder

      public Prefix1Builder(OspfPrefixAttributes arg)
      Construct a new builder initialized from specified OspfPrefixAttributes.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfPrefixAttributes from which the builder should be initialized

    • Prefix1Builder

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

  • Method Details