io.lettuce.core

Class IncrexArgs

java.lang.Object

io.lettuce.core.IncrexArgs

All Implemented Interfaces:

CompositeArgument

public class IncrexArgs
extends Object

Argument list builder for the integer-bounded form of the Redis INCREX command. Accepts long lower/upper bounds; paired with the increx(K, long, IncrexArgs) overload on the commands interface (sends BYINT on the wire).

For float-bounded INCREX use IncrexFloatArgs.

Usage:

 IncrexArgs.Builder.ubound(100).saturate().ex(60)
 IncrexArgs.Builder.lbound(0).ubound(100).saturate()
 new IncrexArgs().ex(30).enx()
 

Since:

7.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IncrexArgs.Builder

Constructor Summary

Constructors

Constructor and Description
IncrexArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
protected <K,V> void	buildBounds(CommandArgs<K,V> args) Subclasses emit their typed LBOUND/UBOUND here.
T	enx() Apply the expiry only if the key does not already have one (Expiry only if Not eXists).
T	ex(long seconds)
T	exAt(long timestampSeconds)
IncrexArgs	lbound(long lbound)
T	persist()
T	px(long milliseconds)
T	pxAt(long timestampMilliseconds)
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.
IncrexArgs	ubound(long ubound)

Methods inherited from class java.lang.Object

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

Constructor Detail

IncrexArgs

public IncrexArgs()

Method Detail

lbound

public IncrexArgs lbound(long lbound)

ubound

public IncrexArgs ubound(long ubound)

buildBounds

protected <K,V> void buildBounds(CommandArgs<K,V> args)

Subclasses emit their typed LBOUND/UBOUND here.

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].

ex

public T ex(long seconds)

px

public T px(long milliseconds)

exAt

public T exAt(long timestampSeconds)

pxAt

public T pxAt(long timestampMilliseconds)

persist

public T persist()

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.

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.