Module spring.data.redis

Package org.springframework.data.redis.core.types

Class Expirations<K>

java.lang.Object

org.springframework.data.redis.core.types.Expirations<K>

public class Expirations<K>
extends Object

Value Object linking a number of keys to their Expirations.TimeToLive retaining the order of the original source. Dedicated higher level methods interpret raw expiration values retrieved from a Redis Client.

1. persistent() returns keys that do not have an associated time to live
2. missing() returns keys that do not exist and therefore have no associated time to live
3. ttl() returns the ordered list of expirations based on the raw values
4. expiring() returns the expiring keys along with their time to live

Since:

3.5

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Expirations.Timeouts	Collection of timeouts associated with a TimeUnit.
static class	Expirations.TimeToLive	Expiration holds time to live Expirations.TimeToLive.raw() values as returned by a Redis Client.

Method Summary

Modifier and Type	Method	Description
Expirations.TimeToLive	expirationOf(K key)
List<Map.Entry<K,Duration>>	expiring()
Collection<K>	keys()
Set<K>	missing()
static <K> Expirations<K>	of(TimeUnit targetUnit, List<K> keys, Expirations.Timeouts timeouts)	Factory Method to create Expirations from raw sources provided in a given TimeUnit.
Set<K>	persistent()
TimeUnit	timeUnit()
List<Expirations.TimeToLive>	ttl()
Duration	ttlOf(K key)

Methods inherited from class java.lang.Object

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

Method Details

of

public static <K> Expirations<K> of(TimeUnit targetUnit,
 List<K> keys,
 Expirations.Timeouts timeouts)

Factory Method to create Expirations from raw sources provided in a given TimeUnit.

Type Parameters:

K - the key type used

Parameters:

targetUnit - the actual time unit of the raw timeToLive values.

keys - the keys to associated with the raw values in timeToLive. Defines the actual order of entries within Expirations.

timeouts - the raw Redis time to live values.

Returns:

new instance of Expirations.

persistent

public Set<K> persistent()

Returns:

an ordered set of keys that do not have a time to live.

missing

public Set<K> missing()

Returns:

an ordered set of keys that do not exist and therefore do not have a time to live.

ttl

public List<Expirations.TimeToLive> ttl()

Returns:

an ordered set of all expirations where the Expirations.TimeToLive.value() is using the TimeUnit defined in timeUnit().

timeUnit

public TimeUnit timeUnit()

Returns:

the TimeUnit for expirations held by this instance.

expiring

public List<Map.Entry<K,Duration>> expiring()

Returns:

an ordered List of entries combining keys with their actual time to live. Missing and persistent entries are skipped.

keys

public Collection<K> keys()

Returns:

the ordered collection of keys that are associated with an expiration.

expirationOf

@Nullable
public Expirations.TimeToLive expirationOf(K key)

Parameters:

key -

Returns:

the expirations where the Expirations.TimeToLive.value() is using the TimeUnit defined in timeUnit() or null if no entry could be found.

ttlOf

@Nullable
public Duration ttlOf(K key)

Parameters:

key -

Returns:

the time to live value of the requested key if it exists and the expiration is neither missing nor persistent, null otherwise.