org.openingo.spring.boot.extension.data.redis.commands

Interface IListCommands<K,V>

All Known Subinterfaces:

IRedisCommands<K,V>

All Known Implementing Classes:

RedisIdEngine, RedisStringKeyTemplateX, RedisTemplateX

public interface IListCommands<K,V>

IListCommands

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
V	blPop(K key, long timeoutSeconds) Removes and returns first element from lists stored at key .
V	brPop(K key, long timeoutSeconds) Removes and returns last element from lists stored at key.
V	brPoplPush(K srcKey, K dstKey, long timeoutSeconds) Remove the last element from list at srcKey, append it to dstKey and return its value. Blocks connection until element available or timeoutSeconds reached.
V	lIndex(K key, long index) Get element at index form list at key.
Long	lLen(K key) Get the size of list stored at key.
V	lPop(K key) Removes and returns first element in list stored at key.
Long	lPush(K key, Collection<V> values) Prepend values to key.
Long	lPush(K key, V... values) Prepend values to key.
Long	lPush(K key, V value) Prepend value to key.
Long	lPushx(K key, V value) Prepend values to key only if the list exists.
List<V>	lRange(K key, long start, long end) Get elements between begin and end from list at key.
Long	lRem(K key, long count, V value) Removes the first count occurrences of value from the list stored at key.
void	lSet(K key, long index, V value) Set the value list element at index.
void	ltrim(K key, long start, long end) Trim list at key to elements between start and end.
V	rPop(K key) Removes and returns last element in list stored at key.
V	rPoplPush(K srcKey, K dstKey) Remove the last element from list at sourceKey, append it to destinationKey and return its value.
Long	rPush(K key, Collection<V> values) Append values to key.
Long	rPush(K key, V... values) Append values to key.
Long	rPush(K key, V value) Append value to key.
Long	rPushx(K key, V value) Append values to key only if the list exists.

Method Detail

lIndex

@Nullable
V lIndex(K key,
                   long index)

Get element at index form list at key.

Parameters:

key - must not be null.

index -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LINDEX

lLen

@Nullable
Long lLen(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

lPop

@Nullable
V lPop(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

lPush

@Nullable
Long lPush(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

lPush

@Nullable
Long lPush(K key,
                     V... values)

Prepend values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

lPush

@Nullable
Long lPush(K key,
                     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

lPushx

@Nullable
Long lPushx(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

lSet

void lSet(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

lRem

@Nullable
Long lRem(K key,
                    long count,
                    V 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

lRange

@Nullable
List<V> lRange(K key,
                         long start,
                         long end)

Get elements between begin 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

ltrim

void ltrim(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

rPop

@Nullable
V rPop(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

rPoplPush

@Nullable
V rPoplPush(K srcKey,
                      K dstKey)

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

Parameters:

srcKey - must not be null.

dstKey - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: RPOPLPUSH

brPoplPush

@Nullable
V brPoplPush(K srcKey,
                       K dstKey,
                       long timeoutSeconds)

Remove the last element from list at srcKey, append it to dstKey and return its value.
Blocks connection until element available or timeoutSeconds reached.

Parameters:

srcKey - must not be null.

dstKey - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BRPOPLPUSH

rPush

@Nullable
Long rPush(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

rPush

@Nullable
Long rPush(K key,
                     V... values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rPush

@Nullable
Long rPush(K key,
                     Collection<V> values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rPushx

@Nullable
Long rPushx(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

blPop

@Nullable
V blPop(K key,
                  long timeoutSeconds)

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

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BLPOP

brPop

@Nullable
V brPop(K key,
                  long timeoutSeconds)

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

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BRPOP