Package org.redisson

Class RedissonList<V>

java.lang.Object
org.redisson.RedissonObject
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, RSortable<List<V>>, RSortableAsync<List<V>>
Direct Known Subclasses:
RedissonPriorityQueue, RedissonQueue, RedissonSubList
public class RedissonList<V> extends RedissonObject implements RList<V>
Distributed and concurrent implementation of List
Author:
Nikita Koksharov

  • Constructor Details

  • Method Details

    • mapReduce

      public <KOut, VOut> RCollectionMapReduce<V,KOut,VOut> mapReduce()
      Description copied from interface: RList
      Returns RMapReduce object associated with this map
      Specified by:
      mapReduce in interface RList<V>
      Type Parameters:
      KOut - output key
      VOut - output value
      Returns:
      MapReduce instance

    • 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 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 Collection<V>
      Specified by:
      iterator in interface Iterable<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)
      Description copied from interface: RCollectionAsync
      Adds element into this collection.
      Specified by:
      addAsync in interface RCollectionAsync<V>
      Parameters:
      e - - element to add
      Returns:
      true if an element was added and false if it is already present

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

      public RFuture<Boolean> removeAsync(Object o, int count)
      Description copied from interface: RListAsync
      Removes up to count occurrences of element
      Specified by:
      removeAsync in interface RListAsync<V>
      Parameters:
      o - - element to find
      count - - amount occurrences
      Returns:
      true if at least one element removed; or false if element isn't found

    • remove

      public boolean remove(Object o, int count)
      Description copied from interface: RList
      Removes up to count occurrences of element
      Specified by:
      remove in interface RList<V>
      Parameters:
      o - - element to find
      count - - amount occurrences
      Returns:
      true if at least one element removed; or false if element isn't found

    • 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)
      Description copied from interface: RCollectionAsync
      Adds all elements contained in the specified collection
      Specified by:
      addAllAsync in interface RCollectionAsync<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)
      Description copied from interface: RListAsync
      Inserts elements at index. Subsequent elements are shifted.
      Specified by:
      addAllAsync in interface RListAsync<V>
      Parameters:
      index - - index number
      coll - - elements to insert
      Returns:
      true if list changed or false if element isn't found

    • 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.
      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.
      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)
      Description copied from interface: RListAsync
      Get element at index
      Specified by:
      getAsync in interface RListAsync<V>
      Parameters:
      index - - index of object
      Returns:
      element

    • get

      public List<V> get(int... indexes)
      Description copied from interface: RList
      Loads elements by specified indexes
      Specified by:
      get in interface RList<V>
      Parameters:
      indexes - of elements
      Returns:
      list of elements

    • distributedIterator

      public Iterator<V> distributedIterator(int count)
      Description copied from interface: RList
      Returns element iterator that can be shared across multiple applications. Creating multiple iterators on the same object with this method will result in a single shared iterator. See RList.distributedIterator(String, int) for creating different iterators.
      Specified by:
      distributedIterator in interface RList<V>
      Parameters:
      count - batch size
      Returns:
      shared elements iterator

    • distributedIterator

      public Iterator<V> distributedIterator(String iteratorName, int count)
      Description copied from interface: RList
      Returns iterator over elements that match specified pattern. Iterator can be shared across multiple applications. Creating multiple iterators on the same object with this method will result in a single shared iterator. Iterator name must be resolved to the same hash slot as list name.
      Specified by:
      distributedIterator in interface RList<V>
      Parameters:
      iteratorName - redis object name to which cursor will be saved
      count - batch size
      Returns:
      shared elements iterator

    • getAsync

      public RFuture<List<V>> getAsync(int... indexes)
      Description copied from interface: RListAsync
      Loads elements by specified indexes
      Specified by:
      getAsync in interface RListAsync<V>
      Parameters:
      indexes - of elements
      Returns:
      elements

    • 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)
      Description copied from interface: RListAsync
      Set element at index and returns previous element.
      Specified by:
      setAsync in interface RListAsync<V>
      Parameters:
      index - - index of object
      element - - object
      Returns:
      previous element or null if element wasn't set.

    • 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>

    • addAsync

      public RFuture<Boolean> addAsync(int index, V element)
      Description copied from interface: RListAsync
      Inserts element at index. Subsequent elements are shifted.
      Specified by:
      addAsync in interface RListAsync<V>
      Parameters:
      index - - index number
      element - - element to insert
      Returns:
      true if list was changed

    • remove

      public V remove(int index)
      Specified by:
      remove in interface List<V>

    • removeAsync

      public RFuture<V> removeAsync(int index)
      Description copied from interface: RListAsync
      Removes element at index.
      Specified by:
      removeAsync in interface RListAsync<V>
      Parameters:
      index - - index of object
      Returns:
      element or null if element wasn't set.

    • fastRemove

      public void fastRemove(int index)
      Description copied from interface: RList
      Remove object by specified index
      Specified by:
      fastRemove in interface RList<V>
      Parameters:
      index - - index of object

    • fastRemoveAsync

      public RFuture<Void> fastRemoveAsync(int index)
      Description copied from interface: RListAsync
      Removes element at index. Works faster than RListAsync.removeAsync(Object, int) but doesn't return element.
      Specified by:
      fastRemoveAsync in interface RListAsync<V>
      Parameters:
      index - - index of object
      Returns:
      void

    • 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 encoded state of the specified element.
      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 and false otherwise

    • indexOfAsync

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

    • indexOfAsync

      public RFuture<Integer> indexOfAsync(Object o)
      Description copied from interface: RListAsync
      Returns last index of element or -1 if element isn't found
      Specified by:
      indexOfAsync in interface RListAsync<V>
      Parameters:
      o - to find
      Returns:
      index of -1 if element isn't found

    • lastIndexOf

      public int lastIndexOf(Object o)
      Specified by:
      lastIndexOf in interface List<V>

    • lastIndexOfAsync

      public RFuture<Integer> lastIndexOfAsync(Object o)
      Description copied from interface: RListAsync
      Returns last index of element or -1 if element isn't found
      Specified by:
      lastIndexOfAsync in interface RListAsync<V>
      Parameters:
      o - to find
      Returns:
      index of -1 if element isn't found

    • 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(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>
      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
      Inserts 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
      Inserts 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 int 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 int 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

    • readSort

      public List<V> readSort(SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Parameters:
      order - for sorted data
      Returns:
      sorted collection

    • readSortAsync

      public RFuture<List<V>> readSortAsync(SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Parameters:
      order - for sorted data
      Returns:
      sorted collection

    • readSort

      public List<V> readSort(SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Parameters:
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSortAsync

      public RFuture<List<V>> readSortAsync(SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Parameters:
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSort

      public List<V> readSort(String byPattern, SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      sorted collection

    • readSortAsync

      public RFuture<List<V>> readSortAsync(String byPattern, SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      sorted collection

    • readSort

      public List<V> readSort(String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSortAsync

      public RFuture<List<V>> readSortAsync(String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSort

      public <T> Collection<T> readSort(String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      sorted collection

    • readSortAsync

      public <T> RFuture<Collection<T>> readSortAsync(String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      sorted collection

    • readSort

      public <T> Collection<T> readSort(String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view
      Specified by:
      readSort in interface RSortable<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSortAsync

      public <T> RFuture<Collection<T>> readSortAsync(String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view
      Specified by:
      readSortAsync in interface RSortableAsync<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection

    • readSortAlpha

      public List<V> readSortAlpha(SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Parameters:
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public RFuture<List<V>> readSortAlphaAsync(SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Parameters:
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlpha

      public List<V> readSortAlpha(SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Parameters:
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public RFuture<List<V>> readSortAlphaAsync(SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Parameters:
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlpha

      public List<V> readSortAlpha(String byPattern, SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public RFuture<List<V>> readSortAlphaAsync(String byPattern, SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlpha

      public List<V> readSortAlpha(String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public RFuture<List<V>> readSortAlphaAsync(String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlpha

      public <T> Collection<T> readSortAlpha(String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public <T> RFuture<Collection<T>> readSortAlphaAsync(String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlpha

      public <T> Collection<T> readSortAlpha(String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Read data in sorted view lexicographically
      Specified by:
      readSortAlpha in interface RSortable<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • readSortAlphaAsync

      public <T> RFuture<Collection<T>> readSortAlphaAsync(String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Read data in sorted view lexicographically
      Specified by:
      readSortAlphaAsync in interface RSortableAsync<V>
      Type Parameters:
      T - object type
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      sorted collection lexicographically

    • sortTo

      public int sortTo(String destName, SortOrder order)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      order - for sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, SortOrder order)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      order - for sorted data
      Returns:
      length of sorted data

    • sortTo

      public int sortTo(String destName, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • sortTo

      public int sortTo(String destName, String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • sortTo

      public int sortTo(String destName, String byPattern, SortOrder order)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, String byPattern, SortOrder order)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, String byPattern, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • sortTo

      public int sortTo(String destName, String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, String byPattern, List<String> getPatterns, SortOrder order)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      Returns:
      length of sorted data

    • sortTo

      public int sortTo(String destName, String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortable
      Sort data and store to destName list
      Specified by:
      sortTo in interface RSortable<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • sortToAsync

      public RFuture<Integer> sortToAsync(String destName, String byPattern, List<String> getPatterns, SortOrder order, int offset, int count)
      Description copied from interface: RSortableAsync
      Sort data and store to destName list
      Specified by:
      sortToAsync in interface RSortableAsync<V>
      Parameters:
      destName - list object destination
      byPattern - that is used to generate the keys that are used for sorting
      getPatterns - that is used to load values by keys in sorted view
      order - for sorted data
      offset - of sorted data
      count - of sorted data
      Returns:
      length of sorted data

    • rangeAsync

      public RFuture<List<V>> rangeAsync(int toIndex)
      Description copied from interface: RListAsync
      Returns range of values from 0 index to toIndex. Indexes are zero based. -1 means the last element, -2 means penultimate and so on.
      Specified by:
      rangeAsync in interface RListAsync<V>
      Parameters:
      toIndex - - end index
      Returns:
      elements

    • rangeAsync

      public RFuture<List<V>> rangeAsync(int fromIndex, int toIndex)
      Description copied from interface: RListAsync
      Returns range of values from fromIndex to toIndex index including. Indexes are zero based. -1 means the last element, -2 means penultimate and so on.
      Specified by:
      rangeAsync in interface RListAsync<V>
      Parameters:
      fromIndex - - start index
      toIndex - - end index
      Returns:
      elements

    • range

      public List<V> range(int toIndex)
      Description copied from interface: RList
      Returns range of values from 0 index to toIndex. Indexes are zero based. -1 means the last element, -2 means penultimate and so on.
      Specified by:
      range in interface RList<V>
      Parameters:
      toIndex - - end index
      Returns:
      elements

    • range

      public List<V> range(int fromIndex, int toIndex)
      Description copied from interface: RList
      Returns range of values from fromIndex to toIndex index including. Indexes are zero based. -1 means the last element, -2 means penultimate and so on.
      Specified by:
      range in interface RList<V>
      Parameters:
      fromIndex - - start index
      toIndex - - end index
      Returns:
      elements

    • addListener

      public int addListener(ObjectListener listener)
      Description copied from interface: RObject
      Adds object event listener
      Specified by:
      addListener in interface RList<V>
      Specified by:
      addListener in interface RObject
      Overrides:
      addListener in class RedissonObject
      Parameters:
      listener - - object event listener
      Returns:
      listener id
      See Also:

    • addListenerAsync

      public RFuture<Integer> addListenerAsync(ObjectListener listener)
      Description copied from interface: RObjectAsync
      Adds object event listener
      Specified by:
      addListenerAsync in interface RListAsync<V>
      Specified by:
      addListenerAsync in interface RObjectAsync
      Overrides:
      addListenerAsync in class RedissonObject
      Parameters:
      listener - - object event listener
      Returns:
      listener id
      See Also:

    • removeListener

      public void removeListener(int listenerId)
      Description copied from interface: RObject
      Removes object event listener
      Specified by:
      removeListener in interface RObject
      Overrides:
      removeListener in class RedissonObject
      Parameters:
      listenerId - - listener id

    • removeListenerAsync

      public RFuture<Void> removeListenerAsync(int listenerId)
      Description copied from interface: RObjectAsync
      Removes object event listener
      Specified by:
      removeListenerAsync in interface RObjectAsync
      Overrides:
      removeListenerAsync in class RedissonObject
      Parameters:
      listenerId - - listener id

    • removeIf

      public boolean removeIf(Predicate<? super V> filter)
      Specified by:
      removeIf in interface Collection<V>

    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Duration) instead
      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
      Use RExpirableAsync.expireAsync(Duration) instead
      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
      Use RExpirable.expire(Instant) instead
      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
      Use RExpirableAsync.expireAsync(Instant) instead
      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

    • expire

      public boolean expire(Instant instant)
      Description copied from interface: RExpirable
      Sets an expiration date for this object. When expire date comes the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      instant - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      public boolean expireIfSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      public boolean expireIfNotSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      public boolean expireIfGreater(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      public boolean expireIfLess(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(Instant instant)
      Description copied from interface: RExpirableAsync
      Set an expire date for object. When expire date comes the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      instant - - expire date
      Returns:
      true if the timeout was set and false if not

    • expire

      public boolean expire(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireAt

      public boolean expireAt(Date timestamp)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Instant) instead
      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
      Use RExpirableAsync.expireAsync(Instant) instead
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      public boolean expireIfSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      public boolean expireIfNotSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      public boolean expireIfGreater(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      public boolean expireIfLess(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      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.

    • getExpireTime

      public long getExpireTime()
      Description copied from interface: RExpirable
      Expiration time of Redisson object that has a timeout

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTime in interface RExpirable
      Returns:
      expiration time

    • getExpireTimeAsync

      public RFuture<Long> getExpireTimeAsync()
      Description copied from interface: RExpirableAsync
      Expiration time of Redisson object that has a timeout

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTimeAsync in interface RExpirableAsync
      Returns:
      expiration time

    • expireAsync

      protected RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)

    • expireAtAsync

      protected RFuture<Boolean> expireAtAsync(long timestamp, String param, String... keys)

    • clearExpireAsync

      protected RFuture<Boolean> clearExpireAsync(String... keys)