org.springframework.data.redis.core

Interface ReactiveListOperations<K,V>

public interface ReactiveListOperations<K,V>

Redis list specific operations.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

See Also:

Redis Documentation: List Commands

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Boolean>	delete(K key) Removes the given key.
reactor.core.publisher.Mono<V>	index(K key, long index) Get element at index form list at key.
reactor.core.publisher.Mono<V>	leftPop(K key) Removes and returns first element in list stored at key.
reactor.core.publisher.Mono<V>	leftPop(K key, Duration timeout) Removes and returns first element from lists stored at key.
reactor.core.publisher.Mono<Long>	leftPush(K key, V value) Prepend value to key.
reactor.core.publisher.Mono<Long>	leftPush(K key, V pivot, V value) Prepend values to key before value.
reactor.core.publisher.Mono<Long>	leftPushAll(K key, Collection<V> values) Prepend values to key.
reactor.core.publisher.Mono<Long>	leftPushAll(K key, V... values) Prepend values to key.
reactor.core.publisher.Mono<Long>	leftPushIfPresent(K key, V value) Prepend values to key only if the list exists.
reactor.core.publisher.Flux<V>	range(K key, long start, long end) Get elements between begin and end from list at key.
reactor.core.publisher.Mono<Long>	remove(K key, long count, Object value) Removes the first count occurrences of value from the list stored at key.
reactor.core.publisher.Mono<V>	rightPop(K key) Removes and returns last element in list stored at key.
reactor.core.publisher.Mono<V>	rightPop(K key, Duration timeout) Removes and returns last element from lists stored at key.
reactor.core.publisher.Mono<V>	rightPopAndLeftPush(K sourceKey, K destinationKey) Remove the last element from list at sourceKey, append it to destinationKey and return its value.
reactor.core.publisher.Mono<V>	rightPopAndLeftPush(K sourceKey, K destinationKey, Duration timeout) Remove the last element from list at srcKey, append it to dstKey and return its value.
reactor.core.publisher.Mono<Long>	rightPush(K key, V value) Append value to key.
reactor.core.publisher.Mono<Long>	rightPush(K key, V pivot, V value) Append values to key before value.
reactor.core.publisher.Mono<Long>	rightPushAll(K key, Collection<V> values) Append values to key.
reactor.core.publisher.Mono<Long>	rightPushAll(K key, V... values) Append values to key.
reactor.core.publisher.Mono<Long>	rightPushIfPresent(K key, V value) Append values to key only if the list exists.
reactor.core.publisher.Mono<Boolean>	set(K key, long index, V value) Set the value list element at index.
reactor.core.publisher.Mono<Long>	size(K key) Get the size of list stored at key.
reactor.core.publisher.Mono<Boolean>	trim(K key, long start, long end) Trim list at key to elements between start and end.

Method Detail

range

reactor.core.publisher.Flux<V> range(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:

See Also:

Redis Documentation: LRANGE

trim

reactor.core.publisher.Mono<Boolean> trim(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

reactor.core.publisher.Mono<Long> size(K key)

Get the size of list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: LLEN

leftPush

reactor.core.publisher.Mono<Long> leftPush(K key,
                                           V value)

Prepend value to key.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: LPUSH

leftPushAll

reactor.core.publisher.Mono<Long> leftPushAll(K key,
                                              V... values)

Prepend values to key.

Parameters:

key - must not be null.

values -

Returns:

See Also:

Redis Documentation: LPUSH

leftPushAll

reactor.core.publisher.Mono<Long> leftPushAll(K key,
                                              Collection<V> values)

Prepend values to key.

Parameters:

key - must not be null.

values - must not be null.

Returns:

Since:

1.5

See Also:

Redis Documentation: LPUSH

leftPushIfPresent

reactor.core.publisher.Mono<Long> leftPushIfPresent(K key,
                                                    V value)

Prepend values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: LPUSHX

leftPush

reactor.core.publisher.Mono<Long> leftPush(K key,
                                           V pivot,
                                           V value)

Prepend values to key before value.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: LPUSH

rightPush

reactor.core.publisher.Mono<Long> rightPush(K key,
                                            V value)

Append value to key.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: RPUSH

rightPushAll

reactor.core.publisher.Mono<Long> rightPushAll(K key,
                                               V... values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

See Also:

Redis Documentation: RPUSH

rightPushAll

reactor.core.publisher.Mono<Long> rightPushAll(K key,
                                               Collection<V> values)

Append values to key.

Parameters:

key - must not be null.

values -

Returns:

Since:

1.5

See Also:

Redis Documentation: RPUSH

rightPushIfPresent

reactor.core.publisher.Mono<Long> rightPushIfPresent(K key,
                                                     V value)

Append values to key only if the list exists.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: RPUSHX

rightPush

reactor.core.publisher.Mono<Long> rightPush(K key,
                                            V pivot,
                                            V value)

Append values to key before value.

Parameters:

key - must not be null.

value -

Returns:

See Also:

Redis Documentation: RPUSH

set

reactor.core.publisher.Mono<Boolean> set(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

reactor.core.publisher.Mono<Long> remove(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:

See Also:

Redis Documentation: LREM

index

reactor.core.publisher.Mono<V> index(K key,
                                     long index)

Get element at index form list at key.

Parameters:

key - must not be null.

index -

Returns:

See Also:

Redis Documentation: LINDEX

leftPop

reactor.core.publisher.Mono<V> leftPop(K key)

Removes and returns first element in list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: LPOP

leftPop

reactor.core.publisher.Mono<V> leftPop(K key,
                                       Duration timeout)

Removes and returns first element from lists stored at key.
Results return once an element available or timeout reached.

Parameters:

key - must not be null.

timeout - maximal duration to wait until an entry in the list at key is available. Must be either Duration.ZERO or greater second, must not be null. A timeout of zero can be used to wait indefinitely. Durations between zero and one second are not supported.

Returns:

See Also:

Redis Documentation: BLPOP

rightPop

reactor.core.publisher.Mono<V> rightPop(K key)

Removes and returns last element in list stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: RPOP

rightPop

reactor.core.publisher.Mono<V> rightPop(K key,
                                        Duration timeout)

Removes and returns last element from lists stored at key.
Results return once an element available or timeout reached.

Parameters:

key - must not be null.

timeout - maximal duration to wait until an entry in the list at key is available. Must be either Duration.ZERO or greater second, must not be null. A timeout of zero can be used to wait indefinitely. Durations between zero and one second are not supported.

Returns:

See Also:

Redis Documentation: BRPOP

rightPopAndLeftPush

reactor.core.publisher.Mono<V> rightPopAndLeftPush(K sourceKey,
                                                   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:

See Also:

Redis Documentation: RPOPLPUSH

rightPopAndLeftPush

reactor.core.publisher.Mono<V> rightPopAndLeftPush(K sourceKey,
                                                   K destinationKey,
                                                   Duration timeout)

Remove the last element from list at srcKey, append it to dstKey and return its value.
Results return once an element available or timeout reached.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

timeout - maximal duration to wait until an entry in the list at sourceKey is available. Must be either Duration.ZERO or greater second, must not be null. A timeout of zero can be used to wait indefinitely. Durations between zero and one second are not supported.

Returns:

See Also:

Redis Documentation: BRPOPLPUSH

delete

reactor.core.publisher.Mono<Boolean> delete(K key)

Removes the given key.

Parameters:

key - must not be null.