Package org.redisson

Class RedissonSubList<V>

Type Parameters:
V - the type of elements held in this collection
All Implemented Interfaces:
Iterable<V>, Collection<V>, List<V>, RandomAccess, SequencedCollection<V>, 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
  • Constructor Details

  • Method Details

    • 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 BaseRedissonList<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 BaseRedissonList<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 BaseRedissonList<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.
      Specified by:
      removeAsync in interface RCollectionAsync<V>
      Overrides:
      removeAsync in class BaseRedissonList<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 BaseRedissonList<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 BaseRedissonList<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>
      Overrides:
      addAllAsync in class BaseRedissonList<V>
      Parameters:
      index - - index number
      coll - - elements to insert
      Returns:
      true if list changed or false if element isn't found
    • 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>
      Overrides:
      removeAllAsync in class BaseRedissonList<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.
      Specified by:
      retainAllAsync in interface RCollectionAsync<V>
      Overrides:
      retainAllAsync in class BaseRedissonList<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 BaseRedissonList<V>
    • getAsync

      public RFuture<V> getAsync(int index)
      Description copied from interface: RListAsync
      Get element at index
      Specified by:
      getAsync in interface RListAsync<V>
      Overrides:
      getAsync in class BaseRedissonList<V>
      Parameters:
      index - - index of object
      Returns:
      element
    • get

      public V get(int index)
      Specified by:
      get in interface List<V>
      Overrides:
      get in class BaseRedissonList<V>
    • set

      public V set(int index, V element)
      Specified by:
      set in interface List<V>
      Overrides:
      set in class BaseRedissonList<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>
      Overrides:
      setAsync in class BaseRedissonList<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>
      Overrides:
      fastSet in class BaseRedissonList<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 BaseRedissonList<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 BaseRedissonList<V>
    • remove

      public V remove(int index)
      Specified by:
      remove in interface List<V>
      Overrides:
      remove in class BaseRedissonList<V>
    • indexOfAsync

      public <R> RFuture<R> indexOfAsync(Object o, Convertor<R> convertor)
      Overrides:
      indexOfAsync in class BaseRedissonList<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>
      Overrides:
      lastIndexOfAsync in class BaseRedissonList<V>
      Parameters:
      o - to find
      Returns:
      index of -1 if element isn't found
    • listIterator

      public ListIterator<V> listIterator()
      Specified by:
      listIterator in interface List<V>
      Overrides:
      listIterator in class BaseRedissonList<V>
    • listIterator

      public ListIterator<V> listIterator(int fromIndex)
      Specified by:
      listIterator in interface List<V>
      Overrides:
      listIterator in class BaseRedissonList<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 BaseRedissonList<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 BaseRedissonList<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 BaseRedissonList<V>
      Parameters:
      fromIndex - - from index
      toIndex - - to index
    • toString

      public String toString()
      Overrides:
      toString in class BaseRedissonList<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 BaseRedissonList<V>
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Collection<V>
      Specified by:
      hashCode in interface List<V>
      Overrides:
      hashCode in class BaseRedissonList<V>
    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      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
      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
      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
      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
      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
      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)