org.redisson

Class RedissonDeque<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonQueue<V>

org.redisson.RedissonDeque<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, RQueue<V>, RQueueAsync<V>, RSortable<List<V>>, RSortableAsync<List<V>>

Direct Known Subclasses:

RedissonBlockingDeque

public class RedissonDeque<V>
extends RedissonQueue<V>
implements RDeque<V>

Distributed and concurrent implementation of Queue

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Constructor and Description
RedissonDeque(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
RedissonDeque(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

Modifier and Type	Method and Description
void	addFirst(V e)
RFuture<Void>	addFirstAsync(V e) Adds element at the head of this deque.
void	addLast(V e)
RFuture<Void>	addLastAsync(V e) Adds element at the tail of this deque.
boolean	clearExpire() Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
Iterator<V>	descendingIterator()
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
V	getLast()
RFuture<V>	getLastAsync() Returns element at the tail of this deque or null if there are no elements in 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()
RFuture<V>	pollFirstAsync() Retrieves and removes element at the head of this deque.
V	pollLast()
RFuture<V>	pollLastAsync() Retrieves and removes element at the tail of this deque.
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<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.RedissonQueue

element, getFirst, offer, offerAsync, peek, peekAsync, poll, pollAsync, pollLastAndOfferFirstTo, pollLastAndOfferFirstToAsync, remove, removeFirst

Methods inherited from class org.redisson.RedissonList

add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAllAsync, addAsync, addAsync, addAsync, addBefore, addBeforeAsync, clear, contains, containsAll, containsAllAsync, containsAsync, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, get, getAsync, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, mapReduce, 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, remove, removeAll, removeAllAsync, removeAsync, removeAsync, removeAsync, retainAll, retainAllAsync, set, setAsync, size, sizeAsync, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, subList, toArray, toArray, toString, trim, trimAsync

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, 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.Deque

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

Methods inherited from interface org.redisson.api.RQueue

pollLastAndOfferFirstTo, readAll

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RQueueAsync

offerAsync, peekAsync, pollAsync, pollLastAndOfferFirstToAsync, readAllAsync

Methods inherited from interface org.redisson.api.RCollectionAsync

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

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

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

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Detail

RedissonDeque

public RedissonDeque(CommandAsyncExecutor commandExecutor,
                     String name,
                     RedissonClient redisson)

RedissonDeque

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

Method Detail

addFirst

public void addFirst(V e)

Specified by:

addFirst in interface Deque<V>

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

addLast

public void addLast(V e)

Specified by:

addLast in interface Deque<V>

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

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

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

offerLast

public boolean offerLast(V e)

Specified by:

offerLast in interface Deque<V>

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>

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

peekLast

public V peekLast()

Specified by:

peekLast 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

pollFirst

public V pollFirst()

Specified by:

pollFirst in interface Deque<V>

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>

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

push

public void push(V e)

Specified by:

push in interface Deque<V>

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>

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

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

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

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

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

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

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

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

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

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

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

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

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

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.