org.springframework.data.redis.core

Interface BoundListOperations<K,V>

All Superinterfaces:

BoundKeyOperations<K>

public interface BoundListOperations<K,V>
extends BoundKeyOperations<K>

List operations bound to a certain key.

Author:

Costin Leau, Mark Paluch

Method Summary

Modifier and Type	Method and Description
RedisOperations<K,V>	getOperations()
V	index(long index) Get element at index form list at the bound key.
V	leftPop() Removes and returns first element in list stored at the bound key.
V	leftPop(long timeout, TimeUnit unit) Removes and returns first element from lists stored at the bound key .
Long	leftPush(V value) Prepend value to the bound key.
Long	leftPush(V pivot, V value) Prepend values to the bound key before value.
Long	leftPushAll(V... values) Prepend values to the bound key.
Long	leftPushIfPresent(V value) Prepend values to the bound key only if the list exists.
List<V>	range(long start, long end) Get elements between begin and end from list at the bound key.
Long	remove(long count, Object value) Removes the first count occurrences of value from the list stored at the bound key.
V	rightPop() Removes and returns last element in list stored at the bound key.
V	rightPop(long timeout, TimeUnit unit) Removes and returns last element from lists stored at the bound key.
Long	rightPush(V value) Append value to the bound key.
Long	rightPush(V pivot, V value) Append values to the bound key before value.
Long	rightPushAll(V... values) Append values to the bound key.
Long	rightPushIfPresent(V value) Append values to the bound key only if the list exists.
void	set(long index, V value) Set the value list element at index.
Long	size() Get the size of list stored at the bound key.
void	trim(long start, long end) Trim list at the bound key to elements between start and end.

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

expire, expireAt, getExpire, getKey, getType, persist, rename

Method Detail

range

@Nullable
List<V> range(long start,
                        long end)

Get elements between begin and end from list at the bound key.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LRANGE

trim

void trim(long start,
          long end)

Trim list at the bound key to elements between start and end.

Parameters:

start -

end -

See Also:

Redis Documentation: LTRIM

size

@Nullable
Long size()

Get the size of list stored at the bound key.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LLEN

leftPush

@Nullable
Long leftPush(V value)

Prepend value to the bound key.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

leftPushAll

@Nullable
Long leftPushAll(V... values)

Prepend values to the bound key.

Parameters:

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

leftPushIfPresent

@Nullable
Long leftPushIfPresent(V value)

Prepend values to the bound key only if the list exists.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSHX

leftPush

@Nullable
Long leftPush(V pivot,
                        V value)

Prepend values to the bound key before value.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

rightPush

@Nullable
Long rightPush(V value)

Append value to the bound key.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rightPushAll

@Nullable
Long rightPushAll(V... values)

Append values to the bound key.

Parameters:

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rightPushIfPresent

@Nullable
Long rightPushIfPresent(V value)

Append values to the bound key only if the list exists.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSHX

rightPush

@Nullable
Long rightPush(V pivot,
                         V value)

Append values to the bound key before value.

Parameters:

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

set

void set(long index,
         V value)

Set the value list element at index.

Parameters:

index -

value -

See Also:

Redis Documentation: LSET

remove

@Nullable
Long remove(long count,
                      Object value)

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

Parameters:

count -

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LREM

index

@Nullable
V index(long index)

Get element at index form list at the bound key.

Parameters:

index -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LINDEX

leftPop

@Nullable
V leftPop()

Removes and returns first element in list stored at the bound key.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPOP

leftPop

@Nullable
V leftPop(long timeout,
                    TimeUnit unit)

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

Parameters:

timeout -

unit - must not be null.

Returns:

null when timeout reached or used in pipeline / transaction.

See Also:

Redis Documentation: BLPOP

rightPop

@Nullable
V rightPop()

Removes and returns last element in list stored at the bound key.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPOP

rightPop

@Nullable
V rightPop(long timeout,
                     TimeUnit unit)

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

Parameters:

timeout -

unit - must not be null.

Returns:

null when timeout reached or used in pipeline / transaction.

See Also:

Redis Documentation: BRPOP

getOperations

RedisOperations<K,V> getOperations()