org.redisson

Class RedissonDeque<V>

java.lang.Object

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>

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.RedissonList

EVAL_BOOLEAN_ARGS2

Constructor Summary

Constructors

Modifier	Constructor and Description
	RedissonDeque(Codec codec, CommandAsyncExecutor commandExecutor, String name)
protected	RedissonDeque(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFirst(V e)
RFuture<Void>	addFirstAsync(V e)
void	addLast(V e)
RFuture<Void>	addLastAsync(V e)
protected boolean	await(RFuture<?> future, long timeout, TimeUnit timeoutUnit)
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.
boolean	delete() Deletes the object
RFuture<Boolean>	deleteAsync() Delete object in async mode
Iterator<V>	descendingIterator()
protected byte[]	encode(Object value)
protected byte[]	encodeMapKey(Object value)
protected byte[]	encodeMapValue(Object value)
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.
protected <V> V	get(RFuture<V> future)
Codec	getCodec() Returns the underlying Codec used by this RObject
V	getLast()
RFuture<V>	getLastAsync()
String	getName() Returns name of object
boolean	isExists() Check object existence
RFuture<Boolean>	isExistsAsync() Check object existence in async mode.
void	migrate(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance
RFuture<Void>	migrateAsync(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance in async mode
boolean	move(int database) Move object to another database
RFuture<Boolean>	moveAsync(int database) Move object to another database in async mode
protected <V> RPromise<V>	newPromise()
protected <V> RFuture<V>	newSucceededFuture(V result)
boolean	offerFirst(V e)
RFuture<Boolean>	offerFirstAsync(V e)
boolean	offerLast(V e)
RFuture<Boolean>	offerLastAsync(V e)
V	peekFirst()
RFuture<V>	peekFirstAsync()
V	peekLast()
RFuture<V>	peekLastAsync()
V	pollFirst()
RFuture<V>	pollFirstAsync()
V	pollLast()
RFuture<V>	pollLastAsync()
V	pop()
RFuture<V>	popAsync()
void	push(V e)
RFuture<Void>	pushAsync(V e)
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
RFuture<V>	removeFirstAsync()
boolean	removeFirstOccurrence(Object o)
RFuture<Boolean>	removeFirstOccurrenceAsync(Object o)
V	removeLast()
RFuture<V>	removeLastAsync()
boolean	removeLastOccurrence(Object o)
RFuture<Boolean>	removeLastOccurrenceAsync(Object o)
void	rename(String newName) Rename current object key to newName
RFuture<Void>	renameAsync(String newName) Rename current object key to newName in async mode
boolean	renamenx(String newName) Rename current object key to newName only if new key is not exists
RFuture<Boolean>	renamenxAsync(String newName) Rename current object key to newName in async mode only if new key is not exists

Methods inherited from class org.redisson.RedissonQueue

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

Methods inherited from class org.redisson.RedissonList

add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAllAsync, addAsync, addAsync, addBefore, addBeforeAsync, clear, contains, containsAll, containsAllAsync, containsAsync, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, readAll, readAllAsync, remove, remove, remove, remove, removeAll, removeAllAsync, removeAsync, removeAsync, removeAsync, retainAll, retainAllAsync, set, setAsync, size, sizeAsync, subList, toArray, toArray, toString, trim, trimAsync

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, pollLastAndOfferFirstTo

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RQueueAsync

offerAsync, peekAsync, pollAsync, pollLastAndOfferFirstToAsync

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

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonDeque

protected RedissonDeque(CommandAsyncExecutor commandExecutor,
             String name)

RedissonDeque

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

Method Detail

addFirst

public void addFirst(V e)

Specified by:

addFirst in interface Deque<V>

addFirstAsync

public RFuture<Void> addFirstAsync(V e)

Specified by:

addFirstAsync in interface RDequeAsync<V>

addLast

public void addLast(V e)

Specified by:

addLast in interface Deque<V>

addLastAsync

public RFuture<Void> addLastAsync(V e)

Specified by:

addLastAsync in interface RDequeAsync<V>

descendingIterator

public Iterator<V> descendingIterator()

Specified by:

descendingIterator in interface Deque<V>

getLastAsync

public RFuture<V> getLastAsync()

Specified by:

getLastAsync in interface RDequeAsync<V>

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)

Specified by:

offerFirstAsync in interface RDequeAsync<V>

offerLastAsync

public RFuture<Boolean> offerLastAsync(V e)

Specified by:

offerLastAsync in interface RDequeAsync<V>

offerLast

public boolean offerLast(V e)

Specified by:

offerLast in interface Deque<V>

peekFirstAsync

public RFuture<V> peekFirstAsync()

Specified by:

peekFirstAsync in interface RDequeAsync<V>

peekFirst

public V peekFirst()

Specified by:

peekFirst in interface Deque<V>

peekLastAsync

public RFuture<V> peekLastAsync()

Specified by:

peekLastAsync in interface RDequeAsync<V>

peekLast

public V peekLast()

Specified by:

peekLast in interface Deque<V>

pollFirstAsync

public RFuture<V> pollFirstAsync()

Specified by:

pollFirstAsync in interface RDequeAsync<V>

pollFirst

public V pollFirst()

Specified by:

pollFirst in interface Deque<V>

pollLastAsync

public RFuture<V> pollLastAsync()

Specified by:

pollLastAsync in interface RDequeAsync<V>

pollLast

public V pollLast()

Specified by:

pollLast in interface Deque<V>

popAsync

public RFuture<V> popAsync()

Specified by:

popAsync in interface RDequeAsync<V>

pop

public V pop()

Specified by:

pop in interface Deque<V>

pushAsync

public RFuture<Void> pushAsync(V e)

Specified by:

pushAsync in interface RDequeAsync<V>

push

public void push(V e)

Specified by:

push in interface Deque<V>

removeFirstOccurrenceAsync

public RFuture<Boolean> removeFirstOccurrenceAsync(Object o)

Specified by:

removeFirstOccurrenceAsync in interface RDequeAsync<V>

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

Specified by:

removeFirstOccurrence in interface Deque<V>

removeFirstAsync

public RFuture<V> removeFirstAsync()

Specified by:

removeFirstAsync in interface RDequeAsync<V>

removeLastAsync

public RFuture<V> removeLastAsync()

Specified by:

removeLastAsync in interface RDequeAsync<V>

removeLast

public V removeLast()

Specified by:

removeLast in interface Deque<V>

removeLastOccurrenceAsync

public RFuture<Boolean> removeLastOccurrenceAsync(Object o)

Specified by:

removeLastOccurrenceAsync in interface RDequeAsync<V>

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 seconds (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

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds

await

protected boolean await(RFuture<?> future,
            long timeout,
            TimeUnit timeoutUnit)
                 throws InterruptedException

Throws:

InterruptedException

get

protected <V> V get(RFuture<V> future)

newPromise

protected <V> RPromise<V> newPromise()

newSucceededFuture

protected <V> RFuture<V> newSucceededFuture(V result)

getName

public String getName()

Description copied from interface: RObject

Returns name of object

Specified by:

getName in interface RObject

Returns:

name - name of object

rename

public void rename(String newName)

Description copied from interface: RObject

Rename current object key to newName

Specified by:

rename in interface RObject

Parameters:

newName - - new name of object

renameAsync

public RFuture<Void> renameAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode

Specified by:

renameAsync in interface RObjectAsync

Parameters:

newName - - new name of object

Returns:

void

migrate

public void migrate(String host,
           int port,
           int database)

Description copied from interface: RObject

Transfer an object from source Redis instance to destination Redis instance

Specified by:

migrate in interface RObject

Parameters:

host - - destination host

port - - destination port

database - - destination database

migrateAsync

public RFuture<Void> migrateAsync(String host,
                         int port,
                         int database)

Description copied from interface: RObjectAsync

Transfer an object from source Redis instance to destination Redis instance in async mode

Specified by:

migrateAsync in interface RObjectAsync

Parameters:

host - - destination host

port - - destination port

database - - destination database

Returns:

void

move

public boolean move(int database)

Description copied from interface: RObject

Move object to another database

Specified by:

move in interface RObject

Parameters:

database - - Redis database number

Returns:

true if key was moved else false

moveAsync

public RFuture<Boolean> moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public boolean renamenx(String newName)

Description copied from interface: RObject

Rename current object key to newName only if new key is not exists

Specified by:

renamenx in interface RObject

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

renamenxAsync

public RFuture<Boolean> renamenxAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode only if new key is not exists

Specified by:

renamenxAsync in interface RObjectAsync

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

delete

public boolean delete()

Description copied from interface: RObject

Deletes the object

Specified by:

delete in interface RObject

Returns:

true if it was exist and deleted else false

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Returns:

true if object was deleted false if not

isExists

public boolean isExists()

Description copied from interface: RObject

Check object existence

Specified by:

isExists in interface RObject

Returns:

true if object exists and false otherwise

isExistsAsync

public RFuture<Boolean> isExistsAsync()

Description copied from interface: RObjectAsync

Check object existence in async mode.

Specified by:

isExistsAsync in interface RObjectAsync

Returns:

true if object exists and false otherwise

getCodec

public Codec getCodec()

Description copied from interface: RObject

Returns the underlying Codec used by this RObject

Specified by:

getCodec in interface RObject

Returns:

Codec of object

encode

protected byte[] encode(Object value)

encodeMapKey

protected byte[] encodeMapKey(Object value)

encodeMapValue

protected byte[] encodeMapValue(Object value)