Interface ListOperations<K,V>

@NullUnmarked
public interface ListOperations<K,V>

Redis list specific operations.

Author:

Costin Leau, David Liu, Thomas Darimont, Christoph Strobl, Mark Paluch, dengliming, Lee Jaeheon, JaeGeun Lee

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ListOperations.MoveFrom<K>	Value object representing the where from part for the LMOVE command.
static class	ListOperations.MoveTo<K>	Value object representing the where to from part for the LMOVE command.

Method Summary

Modifier and Type	Method	Description
default V	getFirst(@NonNull K key)	Returns the first element from the list at key.
default V	getLast(@NonNull K key)	Returns the last element from the list at key.
@NonNull RedisOperations<K,V>	getOperations()
V	index(@NonNull K key, long index)	Get element at index from list at key.
Long	indexOf(@NonNull K key, V value)	Returns the index of the first occurrence of the specified value in the list at key.
Long	lastIndexOf(@NonNull K key, V value)	Returns the index of the last occurrence of the specified value in the list at key.
V	leftPop(@NonNull K key)	Removes and returns first element in list stored at key.
List<V>	leftPop(@NonNull K key, long count)	Removes and returns first elements in list stored at key.
V	leftPop(@NonNull K key, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of leftPop(Object, Duration).
default V	leftPop(@NonNull K key, @NonNull Duration timeout)	Removes and returns first element from lists stored at key .
Long	leftPush(@NonNull K key, @NonNull V pivot, V value)	Insert value to key before pivot.
Long	leftPush(@NonNull K key, V value)	Prepend value to key.
Long	leftPushAll(@NonNull K key, @NonNull Collection<V> values)	Prepend values to key.
Long	leftPushAll(@NonNull K key, V @NonNull ... values)	Prepend values to key.
Long	leftPushIfPresent(@NonNull K key, V value)	Prepend values to key only if the list exists.
V	move(@NonNull K sourceKey, @NonNull RedisListCommands.Direction from, @NonNull K destinationKey, @NonNull RedisListCommands.Direction to)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
V	move(@NonNull K sourceKey, @NonNull RedisListCommands.Direction from, @NonNull K destinationKey, @NonNull RedisListCommands.Direction to, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of move(Object, Direction, Object, Direction, Duration).
default V	move(@NonNull K sourceKey, @NonNull RedisListCommands.Direction from, @NonNull K destinationKey, @NonNull RedisListCommands.Direction to, @NonNull Duration timeout)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
default V	move(@NonNull ListOperations.MoveFrom<K> from, @NonNull ListOperations.MoveTo<K> to)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
default V	move(@NonNull ListOperations.MoveFrom<K> from, @NonNull ListOperations.MoveTo<K> to, @NonNull Duration timeout)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
List<V>	range(@NonNull K key, long start, long end)	Get elements between start and end from list at key.
Long	remove(@NonNull K key, long count, Object value)	Removes the first count occurrences of value from the list stored at key.
V	rightPop(@NonNull K key)	Removes and returns last element in list stored at key.
List<V>	rightPop(@NonNull K key, long count)	Removes and returns last elements in list stored at key.
V	rightPop(@NonNull K key, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of rightPop(Object, Duration).
default V	rightPop(@NonNull K key, @NonNull Duration timeout)	Removes and returns last element from lists stored at key.
V	rightPopAndLeftPush(@NonNull K sourceKey, @NonNull K destinationKey)	Remove the last element from list at sourceKey, append it to destinationKey and return its value.
V	rightPopAndLeftPush(@NonNull K sourceKey, @NonNull K destinationKey, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of rightPopAndLeftPush(Object, Object, Duration).
default V	rightPopAndLeftPush(@NonNull K sourceKey, @NonNull K destinationKey, @NonNull Duration timeout)	Remove the last element from list at sourceKey, append it to destinationKey and return its value. Blocks connection until element available or timeout reached.
Long	rightPush(@NonNull K key, @NonNull V pivot, V value)	Insert value to key after pivot.
Long	rightPush(@NonNull K key, V value)	Append value to key.
Long	rightPushAll(@NonNull K key, @NonNull Collection<V> values)	Append values to key.
Long	rightPushAll(@NonNull K key, V @NonNull ... values)	Append values to key.
Long	rightPushIfPresent(@NonNull K key, V value)	Append values to key only if the list exists.
void	set(@NonNull K key, long index, V value)	Set the value list element at index.
Long	size(@NonNull K key)	Get the size of list stored at key.
void	trim(@NonNull K key, long start, long end)	Trim list at key to elements between start and end.

Method Details

range

List<V> range(@NonNull K key,
 long start,
 long end)

Get elements between start and end from list at key.

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LRANGE

trim

void trim(@NonNull K key,
 long start,
 long end)

Trim list at key to elements between start and end.

Parameters:

key - must not be null.

start -

end -

See Also:

• Redis Documentation: LTRIM

size

Long size(@NonNull K key)

Get the size of list stored at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LLEN

leftPush

Long leftPush(@NonNull K key,
 V value)

Prepend value to key.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LPUSH

leftPushAll

Long leftPushAll(@NonNull K key,
 V @NonNull ... values)

Prepend values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LPUSH

leftPushAll

Long leftPushAll(@NonNull K key,
 @NonNull Collection<V> values)

Prepend values to key.

Parameters:

key - must not be null.

values - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.5

See Also:

• Redis Documentation: LPUSH

leftPushIfPresent

Long leftPushIfPresent(@NonNull K key,
 V value)

Prepend values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LPUSHX

leftPush

Long leftPush(@NonNull K key,
 @NonNull V pivot,
 V value)

Insert value to key before pivot.

Parameters:

key - must not be null.

pivot - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LINSERT

rightPush

Long rightPush(@NonNull K key,
 V value)

Append value to key.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: RPUSH

rightPushAll

Long rightPushAll(@NonNull K key,
 V @NonNull ... values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: RPUSH

rightPushAll

Long rightPushAll(@NonNull K key,
 @NonNull Collection<V> values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

Since:

1.5

See Also:

• Redis Documentation: RPUSH

rightPushIfPresent

Long rightPushIfPresent(@NonNull K key,
 V value)

Append values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: RPUSHX

rightPush

Long rightPush(@NonNull K key,
 @NonNull V pivot,
 V value)

Insert value to key after pivot.

Parameters:

key - must not be null.

pivot - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LINSERT

move

default V move(@NonNull ListOperations.MoveFrom<K> from,
 @NonNull ListOperations.MoveTo<K> to)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Parameters:

from - must not be null.

to - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: LMOVE

move

V move(@NonNull K sourceKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull K destinationKey,
 @NonNull RedisListCommands.Direction to)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Parameters:

sourceKey - must not be null.

from - must not be null.

destinationKey - must not be null.

to - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: LMOVE

move

default V move(@NonNull ListOperations.MoveFrom<K> from,
 @NonNull ListOperations.MoveTo<K> to,
 @NonNull Duration timeout)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Blocks connection until element available or timeout reached.

Parameters:

from - must not be null.

to - must not be null.

timeout - must not be null or negative.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: BLMOVE

move

default V move(@NonNull K sourceKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull K destinationKey,
 @NonNull RedisListCommands.Direction to,
 @NonNull Duration timeout)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Blocks connection until element available or timeout reached.

Parameters:

sourceKey - must not be null.

from - must not be null.

destinationKey - must not be null.

to - must not be null.

timeout - must not be null or negative.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: BLMOVE

move

@Deprecated(since="4.1")
V move(@NonNull K sourceKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull K destinationKey,
 @NonNull RedisListCommands.Direction to,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of move(Object, Direction, Object, Direction, Duration).

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Blocks connection until element available or timeout reached.

Parameters:

sourceKey - must not be null.

from - must not be null.

destinationKey - must not be null.

to - must not be null.

timeout -

unit -

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: BLMOVE

set

void set(@NonNull K key,
 long index,
 V value)

Set the value list element at index.

Parameters:

key - must not be null.

index -

value -

See Also:

• Redis Documentation: LSET

remove

Long remove(@NonNull K key,
 long count,
 Object value)

Removes the first count occurrences of value from the list stored at key.

Parameters:

key - must not be null.

count -

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LREM

getFirst

default V getFirst(@NonNull K key)

Returns the first element from the list at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.4

getLast

default V getLast(@NonNull K key)

Returns the last element from the list at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.4

index

V index(@NonNull K key,
 long index)

Get element at index from list at key.

Parameters:

key - must not be null.

index -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LINDEX

indexOf

Long indexOf(@NonNull K key,
 V value)

Returns the index of the first occurrence of the specified value in the list at key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction or when not contained in list.

Since:

2.4

See Also:

• Redis Documentation: LPOS

lastIndexOf

Long lastIndexOf(@NonNull K key,
 V value)

Returns the index of the last occurrence of the specified value in the list at key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction or when not contained in list.

Since:

2.4

See Also:

• Redis Documentation: LPOS

leftPop

V leftPop(@NonNull K key)

Removes and returns first element in list stored at key.

Parameters:

key - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: LPOP

leftPop

List<V> leftPop(@NonNull K key,
 long count)

Removes and returns first elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: LPOP

leftPop

@Deprecated(since="4.1")
V leftPop(@NonNull K key,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of leftPop(Object, Duration).

Removes and returns first element from lists stored at key .
Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout -

unit - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: BLPOP

leftPop

default V leftPop(@NonNull K key,
 @NonNull Duration timeout)

Removes and returns first element from lists stored at key .
Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout - must not be null.

Returns:

can be null.

Throws:

IllegalArgumentException - if the timeout is null or negative.

Since:

2.3

See Also:

• Redis Documentation: BLPOP

rightPop

V rightPop(@NonNull K key)

Removes and returns last element in list stored at key.

Parameters:

key - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: RPOP

rightPop

List<V> rightPop(@NonNull K key,
 long count)

Removes and returns last elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

can be null.

Since:

2.6

See Also:

• Redis Documentation: RPOP

rightPop

@Deprecated(since="4.1")
V rightPop(@NonNull K key,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of rightPop(Object, Duration).

Removes and returns last element from lists stored at key.
Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout -

unit - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: BRPOP

rightPop

default V rightPop(@NonNull K key,
 @NonNull Duration timeout)

Removes and returns last element from lists stored at key.
Blocks connection until element available or timeout reached.

Parameters:

key - must not be null.

timeout - must not be null.

Returns:

can be null.

Since:

2.3

See Also:

• Redis Documentation: BRPOP

rightPopAndLeftPush

V rightPopAndLeftPush(@NonNull K sourceKey,
 @NonNull K destinationKey)

Remove the last element from list at sourceKey, append it to destinationKey and return its value.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: RPOPLPUSH

rightPopAndLeftPush

@Deprecated(since="4.1")
V rightPopAndLeftPush(@NonNull K sourceKey,
 @NonNull K destinationKey,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of rightPopAndLeftPush(Object, Object, Duration).

Remove the last element from list at sourceKey, append it to destinationKey and return its value.
Blocks connection until element available or timeout reached.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

timeout -

unit - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: BRPOPLPUSH

rightPopAndLeftPush

default V rightPopAndLeftPush(@NonNull K sourceKey,
 @NonNull K destinationKey,
 @NonNull Duration timeout)

Remove the last element from list at sourceKey, append it to destinationKey and return its value.
Blocks connection until element available or timeout reached.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

timeout - must not be null.

Returns:

can be null.

Throws:

IllegalArgumentException - if the timeout is null or negative.

Since:

2.3

See Also:

• Redis Documentation: BRPOPLPUSH

getOperations

@NonNull RedisOperations<K,V> getOperations()

Returns:

the underlying RedisOperations used to execute commands.