org.redisson

Class RedissonList<V>

java.lang.Object

org.redisson.RedissonList<V>

Type Parameters:

V - the type of elements held in this collection

All Implemented Interfaces:

Iterable<V>, Collection<V>, List<V>, RandomAccess, RCollectionAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync

Direct Known Subclasses:

RedissonQueue, RedissonSubList

public class RedissonList<V>
extends Object
implements RList<V>

Distributed and concurrent implementation of List

Author:

Nikita Koksharov

Field Summary

Fields

Modifier and Type	Field and Description
static RedisCommand<Boolean>	EVAL_BOOLEAN_ARGS2

Constructor Summary

Constructors

Constructor and Description
RedissonList(Codec codec, CommandAsyncExecutor commandExecutor, String name)
RedissonList(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, V element)
boolean	add(V e)
Integer	addAfter(V elementToFind, V element) Add element after elementToFind
RFuture<Integer>	addAfterAsync(V elementToFind, V element) Add element after elementToFind
boolean	addAll(Collection<? extends V> c)
boolean	addAll(int index, Collection<? extends V> coll)
RFuture<Boolean>	addAllAsync(Collection<? extends V> c)
RFuture<Boolean>	addAllAsync(int index, Collection<? extends V> coll)
RFuture<Boolean>	addAsync(V e)
protected <T> RFuture<T>	addAsync(V e, RedisCommand<T> command)
Integer	addBefore(V elementToFind, V element) Add element before elementToFind
RFuture<Integer>	addBeforeAsync(V elementToFind, V element) Add element before elementToFind
protected boolean	await(RFuture<?> future, long timeout, TimeUnit timeoutUnit)
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.
boolean	delete() Deletes the object
RFuture<Boolean>	deleteAsync() Delete object in async mode
protected byte[]	encode(Object value)
protected byte[]	encodeMapKey(Object value)
protected byte[]	encodeMapValue(Object value)
boolean	equals(Object o)
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.
void	fastRemove(int index)
RFuture<Void>	fastRemoveAsync(long index)
void	fastSet(int index, V element) Set element at index.
RFuture<Void>	fastSetAsync(int index, V element) Set element at index.
V	get(int index)
protected <V> V	get(RFuture<V> future)
RFuture<V>	getAsync(int index)
Codec	getCodec() Returns the underlying Codec used by this RObject
String	getName() Returns name of object
int	hashCode()
int	indexOf(Object o)
RFuture<Integer>	indexOfAsync(Object o)
<R> RFuture<R>	indexOfAsync(Object o, Convertor<R> convertor)
boolean	isEmpty()
boolean	isExists() Check object existence
RFuture<Boolean>	isExistsAsync() Check object existence in async mode.
Iterator<V>	iterator()
int	lastIndexOf(Object o)
RFuture<Integer>	lastIndexOfAsync(Object o)
<R> RFuture<R>	lastIndexOfAsync(Object o, Convertor<R> convertor)
ListIterator<V>	listIterator()
ListIterator<V>	listIterator(int ind)
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)
List<V>	readAll() Read all elements at once
RFuture<List<V>>	readAllAsync() Read all elements at once
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(int index)
V	remove(long index)
boolean	remove(Object o)
protected boolean	remove(Object o, int count)
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<V>	removeAsync(long index)
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)
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
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).
V	set(int index, V element)
RFuture<V>	setAsync(int index, V element)
int	size()
RFuture<Integer>	sizeAsync() Returns the number of elements in this collection.
RList<V>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()
void	trim(int fromIndex, int toIndex) Trim list and remains elements only in specified range fromIndex, inclusive, and toIndex, inclusive.
RFuture<Void>	trimAsync(long fromIndex, long toIndex) Trim list and remains elements only in specified range fromIndex, inclusive, and toIndex, inclusive.

Methods inherited from class java.lang.Object

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

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

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Field Detail

EVAL_BOOLEAN_ARGS2

public static final RedisCommand<Boolean> EVAL_BOOLEAN_ARGS2

Constructor Detail

RedissonList

public RedissonList(CommandAsyncExecutor commandExecutor,
            String name)

RedissonList

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

Method Detail

size

public int size()

Specified by:

size in interface Collection<V>

Specified by:

size in interface List<V>

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<V>

Specified by:

isEmpty in interface List<V>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<V>

Specified by:

contains in interface List<V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

Specified by:

iterator in interface List<V>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface List<V>

readAll

public List<V> readAll()

Description copied from interface: RList

Read all elements at once

Specified by:

readAll in interface RList<V>

Returns:

list of values

readAllAsync

public RFuture<List<V>> readAllAsync()

Description copied from interface: RListAsync

Read all elements at once

Specified by:

readAllAsync in interface RListAsync<V>

Returns:

list of values

toArray

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

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface List<V>

add

public boolean add(V e)

Specified by:

add in interface Collection<V>

Specified by:

add in interface List<V>

addAsync

public RFuture<Boolean> addAsync(V e)

Specified by:

addAsync in interface RCollectionAsync<V>

addAsync

protected <T> RFuture<T> addAsync(V e,
                      RedisCommand<T> command)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<V>

Specified by:

remove in interface List<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)

remove

protected boolean remove(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>

Specified by:

containsAll in interface List<V>

addAll

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

Specified by:

addAll in interface Collection<V>

Specified by:

addAll in interface List<V>

addAllAsync

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

Specified by:

addAllAsync in interface RCollectionAsync<V>

addAllAsync

public RFuture<Boolean> addAllAsync(int index,
                           Collection<? extends V> coll)

Specified by:

addAllAsync in interface RListAsync<V>

addAll

public boolean addAll(int index,
             Collection<? extends V> coll)

Specified by:

addAll in interface List<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>

Specified by:

removeAll in interface List<V>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<V>

Specified by:

retainAll in interface List<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>

Specified by:

clear in interface List<V>

getAsync

public RFuture<V> getAsync(int index)

Specified by:

getAsync in interface RListAsync<V>

get

public V get(int index)

Specified by:

get in interface List<V>

set

public V set(int index,
    V element)

Specified by:

set in interface List<V>

setAsync

public RFuture<V> setAsync(int index,
                  V element)

Specified by:

setAsync in interface RListAsync<V>

fastSet

public void fastSet(int index,
           V element)

Description copied from interface: RList

Set element at index. Works faster than List.set(int, Object) but doesn't return previous element.

Specified by:

fastSet in interface RList<V>

Parameters:

index - - index of object

element - - object to set

fastSetAsync

public RFuture<Void> fastSetAsync(int index,
                         V element)

Description copied from interface: RListAsync

Set element at index. Works faster than RListAsync.setAsync(int, Object) but doesn't return previous element.

Specified by:

fastSetAsync in interface RListAsync<V>

Parameters:

index - - index of object

element - - object

Returns:

void

add

public void add(int index,
       V element)

Specified by:

add in interface List<V>

remove

public V remove(int index)

Specified by:

remove in interface List<V>

remove

public V remove(long index)

removeAsync

public RFuture<V> removeAsync(long index)

Specified by:

removeAsync in interface RListAsync<V>

fastRemove

public void fastRemove(int index)

Specified by:

fastRemove in interface RList<V>

fastRemoveAsync

public RFuture<Void> fastRemoveAsync(long index)

Specified by:

fastRemoveAsync in interface RListAsync<V>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<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

indexOfAsync

public <R> RFuture<R> indexOfAsync(Object o,
                          Convertor<R> convertor)

indexOfAsync

public RFuture<Integer> indexOfAsync(Object o)

Specified by:

indexOfAsync in interface RListAsync<V>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<V>

lastIndexOfAsync

public RFuture<Integer> lastIndexOfAsync(Object o)

Specified by:

lastIndexOfAsync in interface RListAsync<V>

lastIndexOfAsync

public <R> RFuture<R> lastIndexOfAsync(Object o,
                              Convertor<R> convertor)

trim

public void trim(int fromIndex,
        int toIndex)

Description copied from interface: RList

Trim list and remains elements only in specified range fromIndex, inclusive, and toIndex, inclusive.

Specified by:

trim in interface RList<V>

Parameters:

fromIndex - - from index

toIndex - - to index

trimAsync

public RFuture<Void> trimAsync(long fromIndex,
                      long toIndex)

Description copied from interface: RListAsync

Trim list and remains elements only in specified range fromIndex, inclusive, and toIndex, inclusive.

Specified by:

trimAsync in interface RListAsync<V>

Parameters:

fromIndex - - from index

toIndex - - to index

Returns:

void

listIterator

public ListIterator<V> listIterator()

Specified by:

listIterator in interface List<V>

listIterator

public ListIterator<V> listIterator(int ind)

Specified by:

listIterator in interface List<V>

subList

public RList<V> subList(int fromIndex,
               int toIndex)

Specified by:

subList in interface List<V>

Specified by:

subList in interface RList<V>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<V>

Specified by:

equals in interface List<V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<V>

Specified by:

hashCode in interface List<V>

Overrides:

hashCode in class Object

addAfterAsync

public RFuture<Integer> addAfterAsync(V elementToFind,
                             V element)

Description copied from interface: RListAsync

Add element after elementToFind

Specified by:

addAfterAsync in interface RListAsync<V>

Parameters:

elementToFind - - object to find

element - - object to add

Returns:

new list size

addBeforeAsync

public RFuture<Integer> addBeforeAsync(V elementToFind,
                              V element)

Description copied from interface: RListAsync

Add element before elementToFind

Specified by:

addBeforeAsync in interface RListAsync<V>

Parameters:

elementToFind - - object to find

element - - object to add

Returns:

new list size

addAfter

public Integer addAfter(V elementToFind,
               V element)

Description copied from interface: RList

Add element after elementToFind

Specified by:

addAfter in interface RList<V>

Parameters:

elementToFind - - object to find

element - - object to add

Returns:

new list size

addBefore

public Integer addBefore(V elementToFind,
                V element)

Description copied from interface: RList

Add element before elementToFind

Specified by:

addBefore in interface RList<V>

Parameters:

elementToFind - - object to find

element - - object to add

Returns:

new list size

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)