Package org.redisson

Class RedissonPriorityDeque<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonPriorityQueue<V>

org.redisson.RedissonPriorityDeque<V>

Type Parameters:

V - the type of elements held in this collection

All Implemented Interfaces:

Iterable<V>, Collection<V>, Deque<V>, List<V>, Queue<V>, RandomAccess, RCollectionAsync<V>, RDeque<V>, RDequeAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync, RPriorityDeque<V>, RPriorityQueue<V>, RQueue<V>, RQueueAsync<V>, RSortable<List<V>>, RSortableAsync<List<V>>

Direct Known Subclasses:

RedissonPriorityBlockingDeque

public class RedissonPriorityDeque<V>
extends RedissonPriorityQueue<V>
implements RPriorityDeque<V>

Distributed and concurrent implementation of Queue

Author:

Nikita Koksharov

Nested Class Summary

Nested classes/interfaces inherited from class org.redisson.RedissonPriorityQueue

RedissonPriorityQueue.BinarySearchResult<V>

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, name

Constructor Summary

Constructors

Modifier	Constructor	Description
	RedissonPriorityDeque(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
protected	RedissonPriorityDeque(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

Modifier and Type	Method	Description
void	addFirst(V e)
RFuture<Void>	addFirstAsync(V e)	Adds element at the head of this deque.
int	addFirstIfExists(V... elements)	Adds element at the head of existing deque.
RFuture<Integer>	addFirstIfExistsAsync(V... elements)	Adds element at the head of existing deque.
void	addLast(V e)
RFuture<Void>	addLastAsync(V e)	Adds element at the tail of this deque.
int	addLastIfExists(V... elements)	Adds element at the tail of existing deque.
RFuture<Integer>	addLastIfExistsAsync(V... elements)	Adds element at the tail of existing deque.
boolean	clearExpire()	Clear an expire timeout or expire date for object.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
Iterator<V>	descendingIterator()
Stream<V>	descendingStream()	Returns stream of elements contained in this deque in reverse order
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expire(Instant instant)	Set an expire date for object.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
V	getLast()
RFuture<V>	getLastAsync()	Returns element at the tail of this deque or null if there are no elements in deque.
V	move(DequeMoveArgs args)	Move element from this deque to the given destination deque.
RFuture<V>	moveAsync(DequeMoveArgs args)	Move element from this deque to the given destination deque.
boolean	offerFirst(V e)
RFuture<Boolean>	offerFirstAsync(V e)	Adds element at the head of this deque.
boolean	offerLast(V e)
RFuture<Boolean>	offerLastAsync(V e)	Adds element at the tail of this deque.
V	peekFirst()
RFuture<V>	peekFirstAsync()	Returns element at the head of this deque or null if there are no elements in deque.
V	peekLast()
RFuture<V>	peekLastAsync()	Returns element at the tail of this deque or null if there are no elements in deque.
V	pollFirst()
List<V>	pollFirst(int limit)	Retrieves and removes the head elements of this queue.
RFuture<V>	pollFirstAsync()	Retrieves and removes element at the head of this deque.
RFuture<List<V>>	pollFirstAsync(int limit)	Retrieves and removes the head elements of this queue.
V	pollLast()
List<V>	pollLast(int limit)	Retrieves and removes the tail elements of this queue.
RFuture<V>	pollLastAsync()	Retrieves and removes element at the tail of this deque.
RFuture<List<V>>	pollLastAsync(int limit)	Retrieves and removes the tail elements of this queue.
V	pop()
RFuture<V>	popAsync()	Retrieves and removes element at the head of this deque.
void	push(V e)
RFuture<Void>	pushAsync(V e)	Adds element at the head of this deque.
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
RFuture<Boolean>	removeAsync(Object o, int count)	Removes up to count occurrences of element
RFuture<V>	removeFirstAsync()	Retrieves and removes the first element of deque.
boolean	removeFirstOccurrence(Object o)
RFuture<Boolean>	removeFirstOccurrenceAsync(Object o)	Removes first occurrence of element o
V	removeLast()
RFuture<V>	removeLastAsync()	Retrieves and removes the last element of deque.
boolean	removeLastOccurrence(Object o)
RFuture<Boolean>	removeLastOccurrenceAsync(Object o)	Removes last occurrence of element o

Methods inherited from class org.redisson.RedissonPriorityQueue

add, addAll, addAsync, binarySearch, clear, clearExpireAsync, comparator, contains, containsAll, deleteAsync, element, expireAsync, expireAtAsync, getFirst, offer, offerAsync, peek, peekAsync, poll, poll, pollAsync, pollAsync, pollLastAndOfferFirstTo, pollLastAndOfferFirstToAsync, remove, remove, removeAll, removeFirst, retainAll, toString, trySetComparator, wrapLockedAsync, wrapLockedAsync

Methods inherited from class org.redisson.RedissonList

add, addAfter, addAfterAsync, addAll, addAllAsync, addAllAsync, addAsync, addAsync, addBefore, addBeforeAsync, addListener, addListenerAsync, containsAllAsync, containsAsync, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, get, getAsync, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, mapReduce, range, range, rangeAsync, rangeAsync, readAll, readAllAsync, readSort, readSort, readSort, readSort, readSort, readSort, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, remove, remove, removeAllAsync, removeAsync, removeAsync, removeIf, removeListener, removeListenerAsync, retainAllAsync, set, setAsync, size, sizeAsync, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, subList, toArray, toArray, trim, trimAsync

Methods inherited from class org.redisson.RedissonObject

addListener, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Deque

add, addAll, contains, element, getFirst, iterator, offer, peek, poll, remove, remove, removeFirst, size

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface org.redisson.api.RCollectionAsync

addAllAsync, addAsync, containsAllAsync, containsAsync, removeAllAsync, removeAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RPriorityQueue

comparator, pollLastAndOfferFirstTo, readAll, trySetComparator

Methods inherited from interface org.redisson.api.RQueue

addListener, poll

Methods inherited from interface org.redisson.api.RQueueAsync

addListenerAsync, offerAsync, peekAsync, pollAsync, pollAsync, pollLastAndOfferFirstToAsync, readAllAsync

Constructor Detail

RedissonPriorityDeque

protected RedissonPriorityDeque(CommandAsyncExecutor commandExecutor,
                                String name,
                                RedissonClient redisson)

RedissonPriorityDeque

public RedissonPriorityDeque(Codec codec,
                             CommandAsyncExecutor commandExecutor,
                             String name,
                             RedissonClient redisson)

Method Detail

addFirstIfExists

public int addFirstIfExists(V... elements)

Description copied from interface: RDeque

Adds element at the head of existing deque.

Specified by:

addFirstIfExists in interface RDeque<V>

Parameters:

elements - - elements to add

Returns:

length of the list

addLastIfExists

public int addLastIfExists(V... elements)

Description copied from interface: RDeque

Adds element at the tail of existing deque.

Specified by:

addLastIfExists in interface RDeque<V>

Parameters:

elements - - elements to add

Returns:

length of the list

addFirstIfExistsAsync

public RFuture<Integer> addFirstIfExistsAsync(V... elements)

Description copied from interface: RDequeAsync

Adds element at the head of existing deque.

Specified by:

addFirstIfExistsAsync in interface RDequeAsync<V>

Parameters:

elements - - elements to add

Returns:

length of the list

addLastIfExistsAsync

public RFuture<Integer> addLastIfExistsAsync(V... elements)

Description copied from interface: RDequeAsync

Adds element at the tail of existing deque.

Specified by:

addLastIfExistsAsync in interface RDequeAsync<V>

Parameters:

elements - - elements to add

Returns:

length of the list

addFirstAsync

public RFuture<Void> addFirstAsync(V e)

Description copied from interface: RDequeAsync

Adds element at the head of this deque.

Specified by:

addFirstAsync in interface RDequeAsync<V>

Parameters:

e - - element to add

Returns:

void

addLastAsync

public RFuture<Void> addLastAsync(V e)

Description copied from interface: RDequeAsync

Adds element at the tail of this deque.

Specified by:

addLastAsync in interface RDequeAsync<V>

Parameters:

e - - element to add

Returns:

void

addFirst

public void addFirst(V e)

Specified by:

addFirst in interface Deque<V>

addLast

public void addLast(V e)

Specified by:

addLast in interface Deque<V>

descendingIterator

public Iterator<V> descendingIterator()

Specified by:

descendingIterator in interface Deque<V>

getLastAsync

public RFuture<V> getLastAsync()

Description copied from interface: RDequeAsync

Returns element at the tail of this deque or null if there are no elements in deque.

Specified by:

getLastAsync in interface RDequeAsync<V>

Returns:

element

getLast

public V getLast()

Specified by:

getLast in interface Deque<V>

offerFirst

public boolean offerFirst(V e)

Specified by:

offerFirst in interface Deque<V>

offerFirstAsync

public RFuture<Boolean> offerFirstAsync(V e)

Description copied from interface: RDequeAsync

Adds element at the head of this deque.

Specified by:

offerFirstAsync in interface RDequeAsync<V>

Parameters:

e - - element to add

Returns:

true if element was added to this deque otherwise false

offerLast

public boolean offerLast(V e)

Specified by:

offerLast in interface Deque<V>

offerLastAsync

public RFuture<Boolean> offerLastAsync(V e)

Description copied from interface: RDequeAsync

Adds element at the tail of this deque.

Specified by:

offerLastAsync in interface RDequeAsync<V>

Parameters:

e - - element to add

Returns:

true if element was added to this deque otherwise false

peekFirstAsync

public RFuture<V> peekFirstAsync()

Description copied from interface: RDequeAsync

Returns element at the head of this deque or null if there are no elements in deque.

Specified by:

peekFirstAsync in interface RDequeAsync<V>

Returns:

element

peekFirst

public V peekFirst()

Specified by:

peekFirst in interface Deque<V>

peekLast

public V peekLast()

Specified by:

peekLast in interface Deque<V>

peekLastAsync

public RFuture<V> peekLastAsync()

Description copied from interface: RDequeAsync

Returns element at the tail of this deque or null if there are no elements in deque.

Specified by:

peekLastAsync in interface RDequeAsync<V>

Returns:

element

pollFirst

public V pollFirst()

Specified by:

pollFirst in interface Deque<V>

pollFirstAsync

public RFuture<V> pollFirstAsync()

Description copied from interface: RDequeAsync

Retrieves and removes element at the head of this deque. Returns null if there are no elements in deque.

Specified by:

pollFirstAsync in interface RDequeAsync<V>

Returns:

element

pollLastAsync

public RFuture<V> pollLastAsync()

Description copied from interface: RDequeAsync

Retrieves and removes element at the tail of this deque. Returns null if there are no elements in deque.

Specified by:

pollLastAsync in interface RDequeAsync<V>

Returns:

element

pollLast

public V pollLast()

Specified by:

pollLast in interface Deque<V>

popAsync

public RFuture<V> popAsync()

Description copied from interface: RDequeAsync

Retrieves and removes element at the head of this deque. Returns null if there are no elements in deque.

Specified by:

popAsync in interface RDequeAsync<V>

Returns:

element

pop

public V pop()

Specified by:

pop in interface Deque<V>

push

public void push(V e)

Specified by:

push in interface Deque<V>

pushAsync

public RFuture<Void> pushAsync(V e)

Description copied from interface: RDequeAsync

Adds element at the head of this deque.

Specified by:

pushAsync in interface RDequeAsync<V>

Parameters:

e - - element to add

Returns:

void

removeAsync

public RFuture<Boolean> removeAsync(Object o,
                                    int count)

Description copied from interface: RListAsync

Removes up to count occurrences of element

Specified by:

removeAsync in interface RListAsync<V>

Overrides:

removeAsync in class RedissonList<V>

Parameters:

o - - element to find

count - - amount occurrences

Returns:

true if at least one element removed; or false if element isn't found

removeFirstOccurrenceAsync

public RFuture<Boolean> removeFirstOccurrenceAsync(Object o)

Description copied from interface: RDequeAsync

Removes first occurrence of element o

Specified by:

removeFirstOccurrenceAsync in interface RDequeAsync<V>

Parameters:

o - - element to remove

Returns:

true if object has been removed otherwise false

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

Specified by:

removeFirstOccurrence in interface Deque<V>

removeFirstAsync

public RFuture<V> removeFirstAsync()

Description copied from interface: RDequeAsync

Retrieves and removes the first element of deque. Returns null if there are no elements in deque.

Specified by:

removeFirstAsync in interface RDequeAsync<V>

Returns:

element

removeLastAsync

public RFuture<V> removeLastAsync()

Description copied from interface: RDequeAsync

Retrieves and removes the last element of deque. Returns null if there are no elements in deque.

Specified by:

removeLastAsync in interface RDequeAsync<V>

Returns:

element

removeLast

public V removeLast()

Specified by:

removeLast in interface Deque<V>

removeLastOccurrenceAsync

public RFuture<Boolean> removeLastOccurrenceAsync(Object o)

Description copied from interface: RDequeAsync

Removes last occurrence of element o

Specified by:

removeLastOccurrenceAsync in interface RDequeAsync<V>

Parameters:

o - - element

Returns:

true if object has been removed otherwise false

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

Specified by:

removeLastOccurrence in interface Deque<V>

descendingStream

public Stream<V> descendingStream()

Description copied from interface: RPriorityDeque

Returns stream of elements contained in this deque in reverse order

Specified by:

descendingStream in interface RPriorityDeque<V>

Returns:

stream of elements in reverse order

pollFirstAsync

public RFuture<List<V>> pollFirstAsync(int limit)

Description copied from interface: RDequeAsync

Retrieves and removes the head elements of this queue. Elements amount limited by limit param.

Specified by:

pollFirstAsync in interface RDequeAsync<V>

Returns:

list of head elements

pollFirst

public List<V> pollFirst(int limit)

Description copied from interface: RDeque

Retrieves and removes the head elements of this queue. Elements amount limited by limit param.

Specified by:

pollFirst in interface RDeque<V>

Returns:

list of head elements

pollLast

public List<V> pollLast(int limit)

Description copied from interface: RDeque

Retrieves and removes the tail elements of this queue. Elements amount limited by limit param.

Specified by:

pollLast in interface RDeque<V>

Returns:

list of tail elements

pollLastAsync

public RFuture<List<V>> pollLastAsync(int limit)

Description copied from interface: RDequeAsync

Retrieves and removes the tail elements of this queue. Elements amount limited by limit param.

Specified by:

pollLastAsync in interface RDequeAsync<V>

Returns:

list of tail elements

move

public V move(DequeMoveArgs args)

Description copied from interface: RDeque

Move element from this deque to the given destination deque. Returns moved element.

Usage examples:

 V element = deque.move(DequeMoveArgs.pollLast()
                                 .addFirstTo("deque2"));
 

 V elements = deque.move(DequeMoveArgs.pollFirst()
                                 .addLastTo("deque2"));
 

Requires Redis 6.2.0 and higher.

Specified by:

move in interface RDeque<V>

Parameters:

args - - arguments object

Returns:

moved element

moveAsync

public RFuture<V> moveAsync(DequeMoveArgs args)

Description copied from interface: RDequeAsync

Move element from this deque to the given destination deque. Returns moved element.

Usage examples:

 V element = deque.move(DequeMoveArgs.pollLast()
                                 .addFirstTo("deque2"));
 

 V elements = deque.move(DequeMoveArgs.pollFirst()
                                 .addLastTo("deque2"));
 

Requires Redis 6.2.0 and higher.

Specified by:

moveAsync in interface RDequeAsync<V>

Parameters:

args - - arguments object

Returns:

moved element

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Instant instant)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Instant instant)

Description copied from interface: RExpirableAsync

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)