Module org.tquadrat.foundation.base
Package org.tquadrat.foundation.lang

Interface SoftLazy<T>

Type Parameters:
T - The type of the cached data.
All Known Implementing Classes:
SoftLazyImpl
@ClassVersion(sourceVersion="$Id: SoftLazy.java 1060 2023-09-24 19:21:40Z tquadrat $") @API(status=STABLE, since="0.0.5") public sealed interface SoftLazy<T> permits SoftLazyImpl<T>
Instances of the class SoftLazy allow to lazy load data that may be needed more than once, but not permanently. An example might be data that is needed during the startup phase of a program, but never again later.

The initializer method that is provided to use(Supplier) must return the same result for each invocation, and this may not be null.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: SoftLazy.java 1060 2023-09-24 19:21:40Z tquadrat $
Since:
0.0.5

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    get()
    Returns the value from this instance of SoftLazy.
    static <D> SoftLazy<D>
    use(Supplier<D> initializer)
    Creates an instance of SoftLazy.

  • Method Details

    • get

      T get()
      Returns the value from this instance of SoftLazy.
      Returns:
      The value.

    • use

      static <D> SoftLazy<D> use(Supplier<D> initializer)
      Creates an instance of SoftLazy.
      Type Parameters:
      D - The type of the cached data.
      Parameters:
      initializer - The initializer method.
      Returns:
      The new instance of SoftLazy.