sirius.kernel.cache

Class InlineCache<E>

java.lang.Object

sirius.kernel.cache.InlineCache<E>

Type Parameters:

E - the type of values being cached

public class InlineCache<E>
extends Object

Caches a single value to prevent frequent re-computation.

Caches a computed value for a certain amount of time. Re-computes the value once the value is expired and the cache is used again.

A real lookup cache, with a Map like behaviour can be found here: Cache.

Use CacheManager.createInlineCache(java.time.Duration, java.util.function.Supplier) to create a new inline cache.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InlineCache(Supplier<E> computer, long timeout) Creates a new inline cache based on the given parameters.

Method Summary

Modifier and Type	Method and Description
void	flush() Forces the cache to reset and re-compute its internal value on the next access
E	get() Either returns a cached value or computes a new one, if no valid value is in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineCache

protected InlineCache(@Nullable
                      Supplier<E> computer,
                      long timeout)

Creates a new inline cache based on the given parameters.

Parameters:

computer - the function used to compute a value if it is not present in the cache

timeout - the time to live (ttl) for the value in milliseconds

Method Detail

get

@Nullable
public E get()

Either returns a cached value or computes a new one, if no valid value is in the cache.

Returns:

a cached or computed value, generated by the internal ValueProvider

flush

public void flush()

Forces the cache to reset and re-compute its internal value on the next access