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

Class Expiration

java.lang.Object

org.springframework.data.redis.core.types.Expiration

public class Expiration
extends Object

Expiration holds a numeric value with an associated TimeUnit.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch, John Blum

See Also:

• Duration
• TimeUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Expiration(long expirationTime, TimeUnit timeUnit)	Creates new Expiration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Expiration	from(long expirationTime, TimeUnit timeUnit)	Creates new Expiration with the provided TimeUnit.
static Expiration	from(Duration duration)	Creates a new Expiration with the given, required Duration.
long	getConverted(TimeUnit targetTimeUnit)	Converts expiration time into the given, desired TimeUnit.
long	getExpirationTime()	Get the length of time for this Expiration.
long	getExpirationTimeInMilliseconds()	Get the expiration time converted into TimeUnit.MILLISECONDS.
long	getExpirationTimeInSeconds()	Get the expiration time converted into TimeUnit.SECONDS.
TimeUnit	getTimeUnit()	Get the configured TimeUnit for the expiration time.
int	hashCode()
boolean	isKeepTtl()
boolean	isPersistent()
boolean	isUnixTimestamp()
static Expiration	keepTtl()	Obtain an Expiration that indicates to keep the existing one, e.g. when sending a SET command.
static Expiration	milliseconds(long expirationTime)	Creates a new Expiration in TimeUnit.MILLISECONDS.
static Expiration	persistent()	Creates a new persistent, non-expiring Expiration.
static Expiration	seconds(long expirationTime)	Creates a new Expiration in TimeUnit.SECONDS.
static Expiration	unixTimestamp(long unixTimestamp, TimeUnit timeUnit)	Creates a new Expiration with the given unix timestamp and TimeUnit.

Methods inherited from class java.lang.Object

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

Constructor Details

Expiration

protected Expiration(long expirationTime,
 @Nullable
 TimeUnit timeUnit)

Creates new Expiration.

Parameters:

expirationTime - length of time for expiration. Defaulted to TimeUnit.SECONDS.

timeUnit - TimeUnit used to measure expirationTime.

Method Details

milliseconds

public static Expiration milliseconds(long expirationTime)

Creates a new Expiration in TimeUnit.MILLISECONDS.

Parameters:

expirationTime - length of time for expiration.

Returns:

a new Expiration measured in TimeUnit.MILLISECONDS.

seconds

public static Expiration seconds(long expirationTime)

Creates a new Expiration in TimeUnit.SECONDS.

Parameters:

expirationTime - length of time for expiration.

Returns:

a new Expiration measured in TimeUnit.SECONDS.

unixTimestamp

public static Expiration unixTimestamp(long unixTimestamp,
 TimeUnit timeUnit)

Creates a new Expiration with the given unix timestamp and TimeUnit.

Parameters:

unixTimestamp - unix timestamp at which the key will expire.

timeUnit - TimeUnit used to measure the expiration period; must not be null.

Returns:

a new Expiration with the given unix timestamp and TimeUnit.

from

public static Expiration from(long expirationTime,
 @Nullable
 TimeUnit timeUnit)

Creates new Expiration with the provided TimeUnit. Greater units than TimeUnit.SECONDS are converted to TimeUnit.SECONDS. Units smaller than TimeUnit.MILLISECONDS are converted to TimeUnit.MILLISECONDS and can lose precision since TimeUnit.MILLISECONDS is the smallest granularity supported by Redis.

Parameters:

expirationTime - length of time for the Expiration.

timeUnit - TimeUnit used to measure the expiration time; can be null. Defaulted to TimeUnit.SECONDS

Returns:

a new Expiration configured with the given length of time in TimeUnit.

from

public static Expiration from(Duration duration)

Creates a new Expiration with the given, required Duration.

Durations with at least seconds resolution uses TimeUnit.SECONDS. Durations in milliseconds use TimeUnit.MILLISECONDS.

Parameters:

duration - must not be null.

Returns:

a new Expiration from the given Duration.

Since:

2.0

keepTtl

public static Expiration keepTtl()

Obtain an Expiration that indicates to keep the existing one, e.g. when sending a SET command.

NOTE: Please follow the documentation for the individual commands to see if keeping the existing TTL is applicable.

Returns:

never null.

Since:

2.4

persistent

public static Expiration persistent()

Creates a new persistent, non-expiring Expiration.

Returns:

a new persistent, non-expiring Expiration.

getExpirationTime

public long getExpirationTime()

Get the length of time for this Expiration.

Returns:

the length of time for this Expiration.

getExpirationTimeInMilliseconds

public long getExpirationTimeInMilliseconds()

Get the expiration time converted into TimeUnit.MILLISECONDS.

Returns:

the expiration time converted into TimeUnit.MILLISECONDS.

getExpirationTimeInSeconds

public long getExpirationTimeInSeconds()

Get the expiration time converted into TimeUnit.SECONDS.

Returns:

the expiration time converted into TimeUnit.SECONDS.

getTimeUnit

public TimeUnit getTimeUnit()

Get the configured TimeUnit for the expiration time.

Returns:

the configured TimeUnit for the expiration time.

getConverted

public long getConverted(TimeUnit targetTimeUnit)

Converts expiration time into the given, desired TimeUnit.

Parameters:

targetTimeUnit - TimeUnit used to convert the getExpirationTime() expiration time}; must not be null.

Returns:

the expiration time converted into the given, desired TimeUnit.

Throws:

IllegalArgumentException - if the given TimeUnit is null.

isPersistent

public boolean isPersistent()

Returns:

true if Expiration is set to persistent.

isKeepTtl

public boolean isKeepTtl()

Returns:

true if Expiration of existing key should not be modified.

Since:

2.4

isUnixTimestamp

public boolean isUnixTimestamp()

Returns:

true if Expiration is set to a specified Unix time at which the key will expire.

Since:

2.6

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object