RedissonSubList (Redisson 2.13.1 API)

java.lang.Object
- org.redisson.RedissonObject
- - org.redisson.RedissonList<V>
  - - org.redisson.RedissonSubList<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, RSortable<List<V>>, RSortableAsync<List<V>>
```
public class RedissonSubList<V>
extends RedissonList<V>
implements RList<V>
```
Distributed and concurrent implementation of List

Author:

Nikita Koksharov

Field Summary
- Fields inherited from class org.redisson.RedissonObject
  codec, commandExecutor

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`RedissonSubList(Codec codec, CommandAsyncExecutor commandExecutor, String name, int fromIndex, int toIndex)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(int index, V element)`
`RFuture<Boolean>`	`addAllAsync(int index, Collection<? extends V> coll)`
`RFuture<Boolean>`	`addAllAsync(Collection<? extends V> c)`	Adds all elements contained in the specified collection
`RFuture<Boolean>`	`addAsync(V e)`	Adds element into this collection.
`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.
`RFuture<Boolean>`	`containsAllAsync(Collection<?> c)`	Returns `true` if this collection contains all of the elements in the specified collection.
`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(long timestamp)`	Set an expire date for object.
`boolean`	`expireAt(Date timestamp)`	Set an expire date for object.
`RFuture<Boolean>`	`expireAtAsync(long timestamp)`	Set an expire date for object in async mode.
`RFuture<Boolean>`	`expireAtAsync(Date timestamp)`	Set an expire date for object in async mode.
`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)`
`RFuture<V>`	`getAsync(int index)`
`int`	`hashCode()`
`<R> RFuture<R>`	`indexOfAsync(Object o, Convertor<R> convertor)`
`RFuture<Integer>`	`lastIndexOfAsync(Object o)`
`ListIterator<V>`	`listIterator()`
`ListIterator<V>`	`listIterator(int fromIndex)`
`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()`	Remaining time to live of Redisson object that has a timeout
`V`	`remove(int index)`
`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).
`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)`
`RFuture<Integer>`	`sizeAsync()`	Returns number of elements in this collection.
`RList<V>`	`subList(int fromIndex, int toIndex)`
`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(int fromIndex, int toIndex)`	Trim list and remains elements only in specified range `fromIndex`, inclusive, and `toIndex`, inclusive.

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
add, addAll, addAll, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.redisson.api.RCollectionAsync
containsAsync

Methods inherited from class org.redisson.RedissonList
add, addAfter, addAfterAsync, addAll, addAll, addAsync, addBefore, addBeforeAsync, contains, containsAll, containsAsync, fastRemove, fastRemoveAsync, get, getAsync, indexOf, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, mapReduce, readAll, 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, removeAsync, removeAsync, retainAll, size, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, toArray, toArray

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, suffixName, toSeconds, touch, touchAsync, unlink, unlinkAsync

Methods inherited from interface org.redisson.api.RExpirable
clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync
clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RList
addAfter, addBefore, fastRemove, get, mapReduce, readAll

Methods inherited from interface org.redisson.api.RListAsync
addAfterAsync, addBeforeAsync, fastRemoveAsync, getAsync, indexOfAsync, removeAsync

Methods inherited from interface org.redisson.api.RObject
copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RSortable
readSort, readSort, readSort, readSort, readSort, readSort, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo

Methods inherited from interface org.redisson.api.RSortableAsync
readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync

- Constructor Detail
  - RedissonSubList
```
protected RedissonSubList(Codec codec,
                          CommandAsyncExecutor commandExecutor,
                          String name,
                          int fromIndex,
                          int toIndex)
```
- Method Detail
  - sizeAsync
```
public RFuture<Integer> sizeAsync()
```
    Description copied from interface: RCollectionAsync
    
    Returns number of elements in this collection.
    
    Specified by:
    
    sizeAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    sizeAsync in class RedissonList<V>
    
    Returns:
    
    size of collection
  - readAllAsync
```
public RFuture<List<V>> readAllAsync()
```
    Description copied from interface: RListAsync
    
    Read all elements at once
    
    Specified by:
    
    readAllAsync in interface RListAsync<V>
    
    Overrides:
    
    readAllAsync in class RedissonList<V>
    
    Returns:
    
    list of values
  - addAsync
```
public RFuture<Boolean> addAsync(V e)
```
    Description copied from interface: RCollectionAsync
    
    Adds element into this collection.
    
    Specified by:
    
    addAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    addAsync in class RedissonList<V>
    
    Parameters:
    
    e - - element to add
    
    Returns:
    
    true if an element was added and false if it is already present
  - 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).
    
    Specified by:
    
    removeAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    removeAsync in class RedissonList<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
  - 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>
    
    Overrides:
    
    containsAllAsync in class RedissonList<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
  - addAllAsync
```
public RFuture<Boolean> addAllAsync(Collection<? extends V> c)
```
    Description copied from interface: RCollectionAsync
    
    Adds all elements contained in the specified collection
    
    Specified by:
    
    addAllAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    addAllAsync in class RedissonList<V>
    
    Parameters:
    
    c - - collection of elements to add
    
    Returns:
    
    true if at least one element was added and false if all elements are already present
  - addAllAsync
```
public RFuture<Boolean> addAllAsync(int index,
                                    Collection<? extends V> coll)
```
    Specified by:
    
    addAllAsync in interface RListAsync<V>
    
    Overrides:
    
    addAllAsync in class RedissonList<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).
    
    Specified by:
    
    removeAllAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    removeAllAsync in class RedissonList<V>
    
    Parameters:
    
    c - collection containing elements to be removed from this collection
    
    Returns:
    
    true if this collection changed as a result of the call
  - 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).
    
    Specified by:
    
    retainAllAsync in interface RCollectionAsync<V>
    
    Overrides:
    
    retainAllAsync in class RedissonList<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>
    
    Overrides:
    
    clear in class RedissonList<V>
  - getAsync
```
public RFuture<V> getAsync(int index)
```
    Specified by:
    
    getAsync in interface RListAsync<V>
    
    Overrides:
    
    getAsync in class RedissonList<V>
  - get
```
public V get(int index)
```
    Specified by:
    
    get in interface List<V>
    
    Overrides:
    
    get in class RedissonList<V>
  - set
```
public V set(int index,
             V element)
```
    Specified by:
    
    set in interface List<V>
    
    Overrides:
    
    set in class RedissonList<V>
  - setAsync
```
public RFuture<V> setAsync(int index,
                           V element)
```
    Specified by:
    
    setAsync in interface RListAsync<V>
    
    Overrides:
    
    setAsync in class RedissonList<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>
    
    Overrides:
    
    fastSet in class RedissonList<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>
    
    Overrides:
    
    fastSetAsync in class RedissonList<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>
    
    Overrides:
    
    add in class RedissonList<V>
  - remove
```
public V remove(int index)
```
    Specified by:
    
    remove in interface List<V>
    
    Overrides:
    
    remove in class RedissonList<V>
  - indexOfAsync
```
public <R> RFuture<R> indexOfAsync(Object o,
                                   Convertor<R> convertor)
```
    Overrides:
    
    indexOfAsync in class RedissonList<V>
  - lastIndexOfAsync
```
public RFuture<Integer> lastIndexOfAsync(Object o)
```
    Specified by:
    
    lastIndexOfAsync in interface RListAsync<V>
    
    Overrides:
    
    lastIndexOfAsync in class RedissonList<V>
  - listIterator
```
public ListIterator<V> listIterator()
```
    Specified by:
    
    listIterator in interface List<V>
    
    Overrides:
    
    listIterator in class RedissonList<V>
  - listIterator
```
public ListIterator<V> listIterator(int fromIndex)
```
    Specified by:
    
    listIterator in interface List<V>
    
    Overrides:
    
    listIterator in class RedissonList<V>
  - subList
```
public RList<V> subList(int fromIndex,
                        int toIndex)
```
    Specified by:
    
    subList in interface List<V>
    
    Specified by:
    
    subList in interface RList<V>
    
    Overrides:
    
    subList in class RedissonList<V>
  - trimAsync
```
public RFuture<Void> trimAsync(int fromIndex,
                               int 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>
    
    Overrides:
    
    trimAsync in class RedissonList<V>
    
    Parameters:
    
    fromIndex - - from index
    
    toIndex - - to index
    
    Returns:
    
    void
  - 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>
    
    Overrides:
    
    trim in class RedissonList<V>
    
    Parameters:
    
    fromIndex - - from index
    
    toIndex - - to index
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class RedissonList<V>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<V>
    
    Specified by:
    
    equals in interface List<V>
    
    Overrides:
    
    equals in class RedissonList<V>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<V>
    
    Specified by:
    
    hashCode in interface List<V>
    
    Overrides:
    
    hashCode in class RedissonList<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
    
    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.

Class RedissonSubList<V>

Field Summary

Fields inherited from class org.redisson.RedissonObject

Constructor Summary

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from class java.lang.Object

Methods inherited from interface org.redisson.api.RCollectionAsync

Methods inherited from class org.redisson.RedissonList

Methods inherited from class org.redisson.RedissonObject

Methods inherited from interface org.redisson.api.RExpirable

Methods inherited from interface org.redisson.api.RExpirableAsync

Methods inherited from interface org.redisson.api.RList

Methods inherited from interface org.redisson.api.RListAsync

Methods inherited from interface org.redisson.api.RObject

Methods inherited from interface org.redisson.api.RObjectAsync

Methods inherited from interface org.redisson.api.RSortable

Methods inherited from interface org.redisson.api.RSortableAsync

Constructor Detail

RedissonSubList

Method Detail

sizeAsync

readAllAsync

addAsync

removeAsync

containsAllAsync

addAllAsync

addAllAsync

removeAllAsync

retainAllAsync

clear

getAsync

get

set

setAsync

fastSet

fastSetAsync

add

remove

indexOfAsync

lastIndexOfAsync

listIterator

listIterator

subList

trimAsync

trim

toString

equals

hashCode

expire

expireAsync

expireAt

expireAtAsync

expireAt

expireAtAsync

clearExpire

clearExpireAsync

remainTimeToLive

remainTimeToLiveAsync