org.springframework.data.redis.connection

Interface RedisListCommands

All Known Subinterfaces:

RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisListCommands

List-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedisListCommands.Position List insertion position.

Method Summary

Modifier and Type	Method and Description
List<byte[]>	bLPop(int timeout, byte[]... keys) Removes and returns first element from lists stored at keys (see: lPop(byte[])).
List<byte[]>	bRPop(int timeout, byte[]... keys) Removes and returns last element from lists stored at keys (see: rPop(byte[])).
byte[]	bRPopLPush(int timeout, byte[] srcKey, byte[] dstKey) Remove the last element from list at srcKey, append it to dstKey and return its value (see rPopLPush(byte[], byte[])).
byte[]	lIndex(byte[] key, long index) Get element at index form list at key.
Long	lInsert(byte[] key, RedisListCommands.Position where, byte[] pivot, byte[] value) Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.
Long	lLen(byte[] key) Get the size of list stored at key.
byte[]	lPop(byte[] key) Removes and returns first element in list stored at key.
Long	lPush(byte[] key, byte[]... values) Prepend values to key.
Long	lPushX(byte[] key, byte[] value) Prepend values to key only if the list exists.
List<byte[]>	lRange(byte[] key, long begin, long end) Get elements between begin and end from list at key.
Long	lRem(byte[] key, long count, byte[] value) Removes the first count occurrences of value from the list stored at key.
void	lSet(byte[] key, long index, byte[] value) Set the value list element at index.
void	lTrim(byte[] key, long begin, long end) Trim list at key to elements between begin and end.
byte[]	rPop(byte[] key) Removes and returns last element in list stored at key.
byte[]	rPopLPush(byte[] srcKey, byte[] dstKey) Remove the last element from list at srcKey, append it to dstKey and return its value.
Long	rPush(byte[] key, byte[]... values) Append values to key.
Long	rPushX(byte[] key, byte[] value) Append values to key only if the list exists.

Method Detail

rPush

Long rPush(byte[] key,
           byte[]... values)

Append values to key.

See http://redis.io/commands/rpush

Parameters:

key -

values -

Returns:

lPush

Long lPush(byte[] key,
           byte[]... values)

Prepend values to key.

See http://redis.io/commands/lpush

Parameters:

key -

values -

Returns:

rPushX

Long rPushX(byte[] key,
            byte[] value)

Append values to key only if the list exists.

See http://redis.io/commands/rpushx

Parameters:

key -

value -

Returns:

lPushX

Long lPushX(byte[] key,
            byte[] value)

Prepend values to key only if the list exists.

See http://redis.io/commands/lpushx

Parameters:

key -

value -

Returns:

lLen

Long lLen(byte[] key)

Get the size of list stored at key.

See http://redis.io/commands/llen

Parameters:

key -

Returns:

lRange

List<byte[]> lRange(byte[] key,
                    long begin,
                    long end)

Get elements between begin and end from list at key.

See http://redis.io/commands/lrange

Parameters:

key -

begin -

end -

Returns:

lTrim

void lTrim(byte[] key,
           long begin,
           long end)

Trim list at key to elements between begin and end.

See http://redis.io/commands/ltrim

Parameters:

key -

begin -

end -

lIndex

byte[] lIndex(byte[] key,
              long index)

Get element at index form list at key.

See http://redis.io/commands/lindex

Parameters:

key -

index -

Returns:

lInsert

Long lInsert(byte[] key,
             RedisListCommands.Position where,
             byte[] pivot,
             byte[] value)

Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.

See http://redis.io/commands/linsert

Parameters:

key -

where -

pivot -

value -

Returns:

lSet

void lSet(byte[] key,
          long index,
          byte[] value)

Set the value list element at index.

See http://redis.io/commands/lset

Parameters:

key -

index -

value -

lRem

Long lRem(byte[] key,
          long count,
          byte[] value)

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

See http://redis.io/commands/lrem

Parameters:

key -

count -

value -

Returns:

lPop

byte[] lPop(byte[] key)

Removes and returns first element in list stored at key.

See http://redis.io/commands/lpop

Parameters:

key -

Returns:

rPop

byte[] rPop(byte[] key)

Removes and returns last element in list stored at key.

See http://redis.io/commands/rpop

Parameters:

key -

Returns:

bLPop

List<byte[]> bLPop(int timeout,
                   byte[]... keys)

Removes and returns first element from lists stored at keys (see: lPop(byte[])).
Blocks connection until element available or timeout reached.

See http://redis.io/commands/blpop

Parameters:

timeout -

keys -

Returns:

bRPop

List<byte[]> bRPop(int timeout,
                   byte[]... keys)

Removes and returns last element from lists stored at keys (see: rPop(byte[])).
Blocks connection until element available or timeout reached.

See http://redis.io/commands/brpop

Parameters:

timeout -

keys -

Returns:

rPopLPush

byte[] rPopLPush(byte[] srcKey,
                 byte[] dstKey)

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

See http://redis.io/commands/rpoplpush

Parameters:

srcKey -

dstKey -

Returns:

bRPopLPush

byte[] bRPopLPush(int timeout,
                  byte[] srcKey,
                  byte[] dstKey)

Remove the last element from list at srcKey, append it to dstKey and return its value (see rPopLPush(byte[], byte[])).
Blocks connection until element available or timeout reached.

See http://redis.io/commands/brpoplpush

Parameters:

timeout -

srcKey -

dstKey -

Returns: