Package org.springframework.data.redis.support.collections

Interface RedisList<E>

All Superinterfaces:

BlockingDeque<E>, BlockingQueue<E>, BoundKeyOperations<String>, Collection<E>, Deque<E>, Iterable<E>, List<E>, Queue<E>, RedisCollection<E>, RedisStore

All Known Implementing Classes:

DefaultRedisList

public interface RedisList<E>
extends RedisCollection<E>, List<E>, BlockingDeque<E>

Redis extension for the List contract. Supports List, Queue and Deque contracts as well as their equivalent blocking siblings BlockingDeque and BlockingDeque.

Author:

Costin Leau, Mark Paluch

Method Summary

Modifier and Type	Method	Description
static <E> RedisList<E>	create(String key, RedisOperations<String,E> operations)	Constructs a new, uncapped RedisList instance.
static <E> RedisList<E>	create(String key, RedisOperations<String,E> operations, int maxSize)	Constructs a new RedisList instance.
static <E> RedisList<E>	create(BoundListOperations<String,E> boundOps)	Constructs a new, uncapped DefaultRedisList instance.
static <E> RedisList<E>	create(BoundListOperations<String,E> boundOps, int maxSize)	Constructs a new DefaultRedisList instance.
E	moveFirstTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition)	Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
E	moveFirstTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition, long timeout, TimeUnit unit)	Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
default E	moveFirstTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition, Duration timeout)	Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
E	moveLastTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition)	Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
E	moveLastTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition, long timeout, TimeUnit unit)	Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
default E	moveLastTo(RedisList<E> destination, RedisListCommands.Direction destinationPosition, Duration timeout)	Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.
List<E>	range(long start, long end)	Get elements between start and end from list at the bound key.
RedisList<E>	trim(int start, int end)	Trim list at the bound key to elements between start and end.
RedisList<E>	trim(long start, long end)	Trim list at the bound key to elements between start and end.

Methods inherited from interface java.util.concurrent.BlockingDeque

add, addFirst, addLast, contains, element, iterator, offer, offer, offerFirst, offerFirst, offerLast, offerLast, peek, poll, poll, pollFirst, pollLast, push, put, putFirst, putLast, remove, remove, removeFirstOccurrence, removeLastOccurrence, size, take, takeFirst, takeLast

Methods inherited from interface java.util.concurrent.BlockingQueue

drainTo, drainTo, remainingCapacity

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

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Deque

addAll, descendingIterator, getFirst, getLast, peekFirst, peekLast, pollFirst, pollLast, pop, removeFirst, removeLast

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface org.springframework.data.redis.support.collections.RedisStore

getOperations

Method Details

create

static <E> RedisList<E> create(String key,
 RedisOperations<String,E> operations)

Constructs a new, uncapped RedisList instance.

Parameters:

key - Redis key of this list.

operations - RedisOperations for the value type of this list.

Since:

2.6

create

static <E> RedisList<E> create(String key,
 RedisOperations<String,E> operations,
 int maxSize)

Constructs a new RedisList instance.

Parameters:

key - Redis key of this list.

operations - RedisOperations for the value type of this list.

maxSize -

Since:

2.6

create

static <E> RedisList<E> create(BoundListOperations<String,E> boundOps)

Constructs a new, uncapped DefaultRedisList instance.

Parameters:

boundOps - BoundListOperations for the value type of this list.

Since:

2.6

create

static <E> RedisList<E> create(BoundListOperations<String,E> boundOps,
 int maxSize)

Constructs a new DefaultRedisList instance.

Parameters:

boundOps - BoundListOperations for the value type of this list.

maxSize -

Since:

2.6

moveFirstTo

@Nullable
E moveFirstTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition)

Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

moveFirstTo

@Nullable
default E moveFirstTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition,
 Duration timeout)

Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Blocks connection until element available or timeout reached.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

timeout - must not be null or negative.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

moveFirstTo

@Nullable
E moveFirstTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition,
 long timeout,
 TimeUnit unit)

Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Blocks connection until element available or timeout reached.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

timeout -

unit - must not be null.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

moveLastTo

@Nullable
E moveLastTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition)

Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

moveLastTo

@Nullable
default E moveLastTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition,
 Duration timeout)

Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Blocks connection until element available or timeout reached.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

timeout - must not be null or negative.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

moveLastTo

@Nullable
E moveLastTo(RedisList<E> destination,
 RedisListCommands.Direction destinationPosition,
 long timeout,
 TimeUnit unit)

Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the first/last element (head/tail depending on the destinationPosition argument) of the list stored at destination.

Blocks connection until element available or timeout reached.

Parameters:

destination - must not be null.

destinationPosition - must not be null.

timeout -

unit - must not be null.

Returns:

Since:

2.6

See Also:

• RedisListCommands.Direction.first()
• RedisListCommands.Direction.last()

range

List<E> range(long start,
 long end)

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

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LRANGE

trim

RedisList<E> trim(int start,
 int end)

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

Parameters:

start -

end -

See Also:

• Redis Documentation: LTRIM

trim

RedisList<E> trim(long start,
 long end)

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

Parameters:

start -

end -

Since:

2.6

See Also:

• Redis Documentation: LTRIM