Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.afi.safi.ll.graceful.restart.ll.graceful.restart

Class ConfigBuilder

java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Config,ConfigBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.afi.safi.ll.graceful.restart.ll.graceful.restart.ConfigBuilder
All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator") public class ConfigBuilder extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Config,ConfigBuilder>
Class that builds Config 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: 

   
     Config createConfig(int fooXyzzy, int barBaz) {
         return new ConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Config, 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
    ConfigBuilder()
    Construct an empty builder.
    ConfigBuilder(Config base)
    Construct a builder initialized with state from specified Config.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Config
    build()
    Returns A new Config instance.
    static @NonNull Config
    empty()
    Returns an empty Config.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24
    getLongLivedStaleTime()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    ConfigBuilder
    setLongLivedStaleTime(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24 value)
    Set the property corresponding to Config.getLongLivedStaleTime() to the specified value.

    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

    • ConfigBuilder

      public ConfigBuilder()
      Construct an empty builder.

    • ConfigBuilder

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

  • Method Details

    • empty

      public static @NonNull Config empty()
      Returns an empty Config.
      Returns:
      an empty Config

    • getLongLivedStaleTime

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24 getLongLivedStaleTime()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Config.getLongLivedStaleTime().
      Returns:
      current value

    • setLongLivedStaleTime

      public ConfigBuilder setLongLivedStaleTime(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24 value)
      Set the property corresponding to Config.getLongLivedStaleTime() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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