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 value with its associated TimeUnit.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Expiration	from(Duration duration) Creates new Expiration with the provided Duration.
static Expiration	from(long expirationTime, TimeUnit timeUnit) Creates new Expiration with the provided TimeUnit.
long	getConverted(TimeUnit targetTimeUnit) Get the expiration time converted into the desired targetTimeUnit.
long	getExpirationTime() Get the expiration time.
long	getExpirationTimeInMilliseconds() Get the expiration time converted into TimeUnit.MILLISECONDS.
long	getExpirationTimeInSeconds() Get the expiration time converted into TimeUnit.SECONDS.
TimeUnit	getTimeUnit() Get the time unit for the expiration time.
boolean	isKeepTtl()
boolean	isPersistent()
boolean	isUnixTimestamp()
static Expiration	keepTtl() Obtain an Expiration that indicates to keep the existing one.
static Expiration	milliseconds(long expirationTime) Creates new Expiration with TimeUnit.MILLISECONDS.
static Expiration	persistent() Creates new persistent Expiration.
static Expiration	seconds(long expirationTime) Creates new Expiration with TimeUnit.SECONDS.
static Expiration	unixTimestamp(long unixTimestamp, TimeUnit timeUnit) Creates new Expiration with the given unix timestamp and TimeUnit.

Methods inherited from class java.lang.Object

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

Constructor Detail

Expiration

protected Expiration(long expirationTime,
                     @Nullable
                     TimeUnit timeUnit)

Creates new Expiration.

Parameters:

expirationTime - can be null. Defaulted to TimeUnit.SECONDS

timeUnit -

Method Detail

getExpirationTimeInMilliseconds

public long getExpirationTimeInMilliseconds()

Get the expiration time converted into TimeUnit.MILLISECONDS.

Returns:

getExpirationTimeInSeconds

public long getExpirationTimeInSeconds()

Get the expiration time converted into TimeUnit.SECONDS.

Returns:

getExpirationTime

public long getExpirationTime()

Get the expiration time.

Returns:

getTimeUnit

public TimeUnit getTimeUnit()

Get the time unit for the expiration time.

Returns:

getConverted

public long getConverted(TimeUnit targetTimeUnit)

Get the expiration time converted into the desired targetTimeUnit.

Parameters:

targetTimeUnit - must not null.

Returns:

Throws:

IllegalArgumentException

seconds

public static Expiration seconds(long expirationTime)

Creates new Expiration with TimeUnit.SECONDS.

Parameters:

expirationTime -

Returns:

milliseconds

public static Expiration milliseconds(long expirationTime)

Creates new Expiration with TimeUnit.MILLISECONDS.

Parameters:

expirationTime -

Returns:

unixTimestamp

public static Expiration unixTimestamp(long unixTimestamp,
                                       TimeUnit timeUnit)

Creates new Expiration with the given unix timestamp and TimeUnit.

Parameters:

unixTimestamp - the unix timestamp at which the key will expire.

timeUnit - must not be null.

Returns:

new instance of Expiration.

keepTtl

public static Expiration keepTtl()

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

NOTE: Please follow the documentation of the individual commands to see if keepTtl() is applicable.

Returns:

never null.

Since:

2.4

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 -

timeUnit - can be null. Defaulted to TimeUnit.SECONDS

Returns:

from

public static Expiration from(Duration duration)

Creates new Expiration with the provided Duration. Durations with at least TimeUnit.SECONDS resolution use seconds, durations using milliseconds use TimeUnit.MILLISECONDS resolution.

Parameters:

duration - must not be null.

Returns:

Since:

2.0

persistent

public static Expiration persistent()

Creates new persistent Expiration.

Returns:

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