redis.clients.jedis.params

Class BaseIncrexParams<T extends BaseIncrexParams<T>>

java.lang.Object

redis.clients.jedis.params.BaseIncrexParams<T>

Type Parameters:

T - the concrete subtype, for fluent method chaining

All Implemented Interfaces:

IParams

Direct Known Subclasses:

IncrexFloatParams, IncrexParams

public abstract class BaseIncrexParams<T extends BaseIncrexParams<T>>
extends java.lang.Object
implements IParams

Abstract base for INCREX parameters. Owns options common to both the integer-bounded variant (IncrexParams) and the float-bounded variant (IncrexFloatParams): SATURATE, the EX/PX/EXAT/PXAT/PERSIST expiration block, and ENX.

Bounds (LBOUND/UBOUND) live on the concrete subclasses so the bound type matches the increment type at compile time — integer-mode increx only accepts IncrexParams, float-mode increx only accepts IncrexFloatParams.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
BaseIncrexParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args) Wire-format emission.
T	enx() Apply the expiry only if the key does not already have one (Expiry only if Not eXists).
boolean	equals(java.lang.Object o)
T	ex(long secondsToExpire) Set the specified expire time, in seconds.
T	exAt(long seconds) Set the specified Unix time at which the key will expire, in seconds.
int	hashCode()
T	persist() Remove the time to live associated with the key.
T	px(long millisecondsToExpire) Set the specified expire time, in milliseconds.
T	pxAt(long milliseconds) Set the specified Unix time at which the key will expire, in milliseconds.
T	saturate() Saturate the result on out-of-bounds: the value is clamped to the violated bound (or the implicit numeric-type limit when no explicit bound is set), and the second element of the reply reflects the actual applied increment.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseIncrexParams

public BaseIncrexParams()

Method Detail

ex

public T ex(long secondsToExpire)

Set the specified expire time, in seconds.

Returns:

parameter object

px

public T px(long millisecondsToExpire)

Set the specified expire time, in milliseconds.

Returns:

parameter object

exAt

public T exAt(long seconds)

Set the specified Unix time at which the key will expire, in seconds.

Returns:

parameter object

pxAt

public T pxAt(long milliseconds)

Set the specified Unix time at which the key will expire, in milliseconds.

Returns:

parameter object

persist

public T persist()

Remove the time to live associated with the key.

Returns:

parameter object

saturate

public T saturate()

Saturate the result on out-of-bounds: the value is clamped to the violated bound (or the implicit numeric-type limit when no explicit bound is set), and the second element of the reply reflects the actual applied increment. Without SATURATE, an out-of-bounds operation is silently rejected: the key value and TTL are unchanged and the reply is [current_value, 0].

Returns:

parameter object

enx

public T enx()

Apply the expiry only if the key does not already have one (Expiry only if Not eXists). If the key already has a TTL, the existing TTL is preserved.

Returns:

parameter object

addParams

public void addParams(CommandArguments args)

Wire-format emission. Order: bounds → SATURATE → expiry → ENX.

Specified by:

addParams in interface IParams

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object