Module org.microbean.function

Package org.microbean.function

Class Suppliers

java.lang.Object

org.microbean.function.Suppliers

public final class Suppliers
extends Object

A utility class containing useful operations for Suppliers.

Author:

Laird Nelson

Method Summary

Modifier and Type	Method	Description
static <R> Supplier<R>	memoize(Supplier<? extends R> s)	Memoizes the supplied Supplier and returns the memoization.
static <R> Supplier<R>	memoize(Supplier<? extends R> s, long durationNanos)	Memoizes the supplied Supplier for a time equal to that represented by the supplied number of nanoseconds and returns the memoization.
static <R> Supplier<R>	memoize(Supplier<? extends R> s, Duration d)	Memoizes the supplied Supplier for a time equal to that represented by the supplied Duration and returns the memoization.

Methods inherited from class java.lang.Object

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

Method Detail

memoize

public static final <R> Supplier<R> memoize(Supplier<? extends R> s)

Memoizes the supplied Supplier and returns the memoization.

The memoization will not call the supplied Supplier's get() method until its own get() method is called.

Type Parameters:

R - the return type of the supplied Supplier

Parameters:

s - the Supplier to memoize; must not be null

Returns:

a memoized version of the supplied Supplier; never null

Throws:

NullPointerException - if s is null

memoize

public static final <R> Supplier<R> memoize(Supplier<? extends R> s,
                                            Duration d)

Memoizes the supplied Supplier for a time equal to that represented by the supplied Duration and returns the memoization.

The memoization will not call the supplied Supplier's get() method until its own get() method is called.

Type Parameters:

R - the return type of the supplied Supplier

Parameters:

s - the Supplier to memoize; must not be null

d - the Duration expressing how long the memoization will survive; must not be null

Returns:

a memoized version of the supplied Supplier; never null

Throws:

NullPointerException - if either argument is null

See Also:

memoize(Supplier, long)

memoize

public static final <R> Supplier<R> memoize(Supplier<? extends R> s,
                                            long durationNanos)

Memoizes the supplied Supplier for a time equal to that represented by the supplied number of nanoseconds and returns the memoization.

The memoization will not call the supplied Supplier's get() method until its own get() method is called.

Type Parameters:

R - the return type of the supplied Supplier

Parameters:

s - the Supplier to memoize; must not be null

durationNanos - the duration, in nanoseconds, expressing how long the memoization will survive

Returns:

a memoized version of the supplied Supplier; never null

Throws:

NullPointerException - if either argument is null