org.redisson

Class RedissonDelayedQueue<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonDelayedQueue<V>

Type Parameters:

V - value type

All Implemented Interfaces:

Iterable<V>, Collection<V>, Queue<V>, RCollectionAsync<V>, RDelayedQueue<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>

public class RedissonDelayedQueue<V>
extends RedissonObject
implements RDelayedQueue<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonDelayedQueue(QueueTransferService queueTransferService, Codec codec, CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method and Description
boolean	add(V e)
boolean	addAll(Collection<? extends V> c)
RFuture<Boolean>	addAllAsync(Collection<? extends V> c)
RFuture<Boolean>	addAsync(V e)
void	clear()
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	contains(Object o)
boolean	containsAll(Collection<?> c)
RFuture<Boolean>	containsAllAsync(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection.
RFuture<Boolean>	containsAsync(Object o) Returns true if this collection contains the specified element.
RFuture<Boolean>	deleteAsync() Delete object in async mode
void	destroy() Destroys object when it's not necessary anymore.
V	element()
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.
boolean	isEmpty()
Iterator<V>	iterator()
boolean	offer(V e)
void	offer(V e, long delay, TimeUnit timeUnit) Inserts element into this queue with specified transfer delay to destination queue.
RFuture<Boolean>	offerAsync(V e)
RFuture<Void>	offerAsync(V e, long delay, TimeUnit timeUnit) Inserts element into this queue with specified transfer delay to destination queue.
V	peek()
RFuture<V>	peekAsync()
V	poll()
RFuture<V>	pollAsync()
V	pollLastAndOfferFirstTo(RQueue<V> deque)
V	pollLastAndOfferFirstTo(String dequeName)
RFuture<V>	pollLastAndOfferFirstToAsync(String queueName)
List<V>	readAll()
RFuture<List<V>>	readAllAsync()
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.
V	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
RFuture<Boolean>	removeAllAsync(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
RFuture<Boolean>	removeAsync(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
protected RFuture<Boolean>	removeAsync(Object o, int count)
boolean	retainAll(Collection<?> c)
RFuture<Boolean>	retainAllAsync(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size()
RFuture<Integer>	sizeAsync() Returns the number of elements in this collection.
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class org.redisson.RedissonObject

await, delete, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync, suffixName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

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

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

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonDelayedQueue

protected RedissonDelayedQueue(QueueTransferService queueTransferService,
                               Codec codec,
                               CommandAsyncExecutor commandExecutor,
                               String name)

Method Detail

offer

public void offer(V e,
                  long delay,
                  TimeUnit timeUnit)

Description copied from interface: RDelayedQueue

Inserts element into this queue with specified transfer delay to destination queue.

Specified by:

offer in interface RDelayedQueue<V>

Parameters:

e - the element to add

delay - for transition

timeUnit - for delay

offerAsync

public RFuture<Void> offerAsync(V e,
                                long delay,
                                TimeUnit timeUnit)

Description copied from interface: RDelayedQueue

Inserts element into this queue with specified transfer delay to destination queue.

Specified by:

offerAsync in interface RDelayedQueue<V>

Parameters:

e - the element to add

delay - for transition

timeUnit - for delay

Returns:

void

add

public boolean add(V e)

Specified by:

add in interface Collection<V>

Specified by:

add in interface Queue<V>

offer

public boolean offer(V e)

Specified by:

offer in interface Queue<V>

remove

public V remove()

Specified by:

remove in interface Queue<V>

poll

public V poll()

Specified by:

poll in interface Queue<V>

element

public V element()

Specified by:

element in interface Queue<V>

peek

public V peek()

Specified by:

peek in interface Queue<V>

size

public int size()

Specified by:

size in interface Collection<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<V>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<V>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<V>

readAll

public List<V> readAll()

Specified by:

readAll in interface RQueue<V>

readAllAsync

public RFuture<List<V>> readAllAsync()

Specified by:

readAllAsync in interface RQueueAsync<V>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<V>

removeAsync

public RFuture<Boolean> removeAsync(Object o)

Description copied from interface: RCollectionAsync

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

removeAsync in interface RCollectionAsync<V>

Parameters:

o - element to be removed from this collection, if present

Returns:

true if an element was removed as a result of this call

removeAsync

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

containsAllAsync

public RFuture<Boolean> containsAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<V>

addAll

public boolean addAll(Collection<? extends V> c)

Specified by:

addAll in interface Collection<V>

removeAllAsync

public RFuture<Boolean> removeAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<V>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<V>

retainAllAsync

public RFuture<Boolean> retainAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

clear

public void clear()

Specified by:

clear in interface Collection<V>

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

peekAsync

public RFuture<V> peekAsync()

Specified by:

peekAsync in interface RQueueAsync<V>

pollAsync

public RFuture<V> pollAsync()

Specified by:

pollAsync in interface RQueueAsync<V>

offerAsync

public RFuture<Boolean> offerAsync(V e)

Specified by:

offerAsync in interface RQueueAsync<V>

pollLastAndOfferFirstToAsync

public RFuture<V> pollLastAndOfferFirstToAsync(String queueName)

Specified by:

pollLastAndOfferFirstToAsync in interface RQueueAsync<V>

containsAsync

public RFuture<Boolean> containsAsync(Object o)

Description copied from interface: RCollectionAsync

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

containsAsync in interface RCollectionAsync<V>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RCollectionAsync

Returns the number of elements in this collection.

Specified by:

sizeAsync in interface RCollectionAsync<V>

Returns:

size of collection

addAsync

public RFuture<Boolean> addAsync(V e)

Specified by:

addAsync in interface RCollectionAsync<V>

addAllAsync

public RFuture<Boolean> addAllAsync(Collection<? extends V> c)

Specified by:

addAllAsync in interface RCollectionAsync<V>

pollLastAndOfferFirstTo

public V pollLastAndOfferFirstTo(String dequeName)

Specified by:

pollLastAndOfferFirstTo in interface RQueue<V>

pollLastAndOfferFirstTo

public V pollLastAndOfferFirstTo(RQueue<V> deque)

Specified by:

pollLastAndOfferFirstTo in interface RQueue<V>

destroy

public void destroy()

Description copied from interface: RDestroyable

Destroys object when it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

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