Package org.springframework.data.redis.cache

Interface RedisCacheWriter.TtlFunction

All Known Implementing Classes:

FixedDurationTtlFunction

Enclosing interface:

RedisCacheWriter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface RedisCacheWriter.TtlFunction

Function to compute the time to live from the cache key and value.

Since:

3.2

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	NO_EXPIRATION

Method Summary

Modifier and Type	Method	Description
Duration	getTimeToLive(Object key, Object value)	Compute a time-to-live (TTL) using the cache key and value.
static RedisCacheWriter.TtlFunction	just(Duration duration)	Creates a Singleton RedisCacheWriter.TtlFunction using the given Duration.
static RedisCacheWriter.TtlFunction	persistent()	Returns a RedisCacheWriter.TtlFunction to create persistent entires that do not expire.

Field Details

NO_EXPIRATION

static final Duration NO_EXPIRATION

Method Details

just

static RedisCacheWriter.TtlFunction just(Duration duration)

Creates a Singleton RedisCacheWriter.TtlFunction using the given Duration.

Parameters:

duration - the time to live. Can be Duration.ZERO for persistent values (i.e. cache entry does not expire).

Returns:

a singleton RedisCacheWriter.TtlFunction using Duration.

persistent

static RedisCacheWriter.TtlFunction persistent()

Returns a RedisCacheWriter.TtlFunction to create persistent entires that do not expire.

Returns:

a RedisCacheWriter.TtlFunction to create persistent entires that do not expire.

getTimeToLive

Duration getTimeToLive(Object key,
 @Nullable
 Object value)

Compute a time-to-live (TTL) using the cache key and value.

The time-to-live (TTL) is computed on each write operation. Redis uses millisecond granularity for timeouts. Any more granular values (e.g. micros or nanos) are not considered and will be truncated due to rounding. Returning Duration.ZERO, or a value less than Duration.ofMillis(1), results in a persistent value that does not expire.

Parameters:

key - the cache key.

value - the cache value. Can be null if the cache supports null value caching.

Returns:

the computed time-to-live (TTL). Can be Duration.ZERO for persistent values (i.e. cache entry does not expire).