Package io.fluxcapacitor.common

Class DefaultMemoizingBiFunction<T,U,R>

java.lang.Object

io.fluxcapacitor.common.DefaultMemoizingBiFunction<T,U,R>

Type Parameters:

T - the type of the first input argument

U - the type of the second input argument

R - the type of the computed result

All Implemented Interfaces:

MemoizingBiFunction<T,U,R>, BiFunction<T,U,R>

public class DefaultMemoizingBiFunction<T,U,R>
extends Object
implements MemoizingBiFunction<T,U,R>

A default implementation of the MemoizingBiFunction interface that memoizes (caches) results of a BiFunction based on a pair of input arguments. Cached results can be reused for identical subsequent calls, and the cache can optionally be configured with a lifespan and a custom clock for time-based eviction. This class internally uses a MemoizingFunction, with the input arguments wrapped as Map.Entry for caching purposes.

Constructor Summary

Constructors

Constructor	Description
DefaultMemoizingBiFunction(BiFunction<T,U,R> delegate)
DefaultMemoizingBiFunction(BiFunction<T,U,R> delegate, Duration lifespan, Clock clock)

Method Summary

Modifier and Type	Method	Description
R	apply(T t, U u)
void	clear()	Clears all cached values.
void	forEach(Consumer<? super R> consumer)	Applies the given consumer to all currently cached values.
boolean	isCached(T t, U u)	Returns true if the function has already cached a value for the given inputs.
R	remove(T t, U u)	Removes the cached result for the given input pair, if present.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface io.fluxcapacitor.common.MemoizingBiFunction

compose

Constructor Details

DefaultMemoizingBiFunction

public DefaultMemoizingBiFunction(BiFunction<T,U,R> delegate)

DefaultMemoizingBiFunction

public DefaultMemoizingBiFunction(BiFunction<T,U,R> delegate,
 Duration lifespan,
 Clock clock)

Method Details

apply

public R apply(T t,
 U u)

Specified by:

apply in interface BiFunction<T,U,R>

isCached

public boolean isCached(T t,
 U u)

Description copied from interface: MemoizingBiFunction

Returns true if the function has already cached a value for the given inputs.

Specified by:

isCached in interface MemoizingBiFunction<T,U,R>

clear

public void clear()

Description copied from interface: MemoizingBiFunction

Clears all cached values.

Specified by:

clear in interface MemoizingBiFunction<T,U,R>

remove

public R remove(T t,
 U u)

Description copied from interface: MemoizingBiFunction

Removes the cached result for the given input pair, if present.

Specified by:

remove in interface MemoizingBiFunction<T,U,R>

Returns:

the previously cached result or null

forEach

public void forEach(Consumer<? super R> consumer)

Description copied from interface: MemoizingBiFunction

Applies the given consumer to all currently cached values.

Specified by:

forEach in interface MemoizingBiFunction<T,U,R>