Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.cluster.id.set.cluster.id.set

Class LocalBuilder

java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Local,LocalBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.cluster.id.set.cluster.id.set.LocalBuilder
All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator") public class LocalBuilder extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Local,LocalBuilder>
Class that builds Local 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: 

   
     Local createLocal(int fooXyzzy, int barBaz) {
         return new LocalBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    Constructors
    Constructor
    Description
    LocalBuilder()
    Construct an empty builder.
    LocalBuilder(Local base)
    Construct a builder initialized with state from specified Local.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Local
    build()
    Returns A new Local instance.

    Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder

    addAugmentation, augmentation, augmentations, removeAugmentation

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LocalBuilder

      public LocalBuilder()
      Construct an empty builder.

    • LocalBuilder

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

  • Method Details

    • build

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