Package org.redisson

Class RedissonSetCache<V>

java.lang.Object
org.redisson.RedissonObject
org.redisson.RedissonSetCache<V>
Type Parameters:
V - value
All Implemented Interfaces:
Iterable<V>, Collection<V>, Set<V>, RCollectionAsync<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RSet<V>, RSetAsync<V>, RSetCache<V>, RSetCacheAsync<V>, RSortable<Set<V>>, RSortableAsync<Set<V>>, ScanIterator
Direct Known Subclasses:
RedissonTransactionalSetCache

public class RedissonSetCache<V> extends RedissonObject implements RSetCache<V>, ScanIterator

Set-based cache with ability to set TTL for each entry via RSetCache.add(Object, long, TimeUnit) method.

Current Redis implementation doesn't have set entry eviction functionality. Thus values are checked for TTL expiration during any value read operation. If entry expired then it doesn't returns and clean task runs asynchronous. Clean task deletes removes 100 expired entries at once. In addition there is EvictionScheduler. This scheduler deletes expired entries in time interval between 5 seconds to 2 hours.

If eviction is not required then it's better to use RSet.

Author:
Nikita Koksharov
  • Constructor Details

  • Method Details

    • mapReduce

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

      public int size()
      Description copied from interface: RSetCache
      Returns the number of elements in cache. This number can reflects expired elements too due to non realtime cleanup process.
      Specified by:
      size in interface Collection<V>
      Specified by:
      size in interface RSetCache<V>
      Specified by:
      size in interface Set<V>
      Returns:
      size of set
    • sizeAsync

      public RFuture<Integer> sizeAsync()
      Description copied from interface: RCollectionAsync
      Returns number of elements in this collection.
      Specified by:
      sizeAsync in interface RCollectionAsync<V>
      Specified by:
      sizeAsync in interface RSetCacheAsync<V>
      Returns:
      size of collection
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Collection<V>
      Specified by:
      isEmpty in interface Set<V>
    • contains

      public boolean contains(Object o)
      Specified by:
      contains in interface Collection<V>
      Specified by:
      contains in interface Set<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
    • scanIterator

      public ScanResult<Object> scanIterator(String name, RedisClient client, long startPos, String pattern, int count)
      Specified by:
      scanIterator in interface ScanIterator
    • scanIteratorAsync

      public RFuture<ScanResult<Object>> scanIteratorAsync(String name, RedisClient client, long startPos, String pattern, int count)
      Specified by:
      scanIteratorAsync in interface ScanIterator
    • iterator

      public Iterator<V> iterator(int count)
      Description copied from interface: RSet
      Returns elements iterator fetches elements in a batch. Batch size is defined by count param.
      Specified by:
      iterator in interface RSet<V>
      Parameters:
      count - - size of elements batch
      Returns:
      iterator
    • iterator

      public Iterator<V> iterator(String pattern)
      Description copied from interface: RSet
      Returns elements iterator. If pattern is not null then only elements match this pattern are loaded.
      Specified by:
      iterator in interface RSet<V>
      Parameters:
      pattern - - search pattern
      Returns:
      iterator
    • iterator

      public Iterator<V> iterator(String pattern, int count)
      Description copied from interface: RSet
      Returns elements iterator fetches elements in a batch. Batch size is defined by count param. If pattern is not null then only elements match this pattern are loaded.
      Specified by:
      iterator in interface RSet<V>
      Parameters:
      pattern - - search pattern
      count - - size of elements batch
      Returns:
      iterator
    • iterator

      public Iterator<V> iterator()
      Specified by:
      iterator in interface Collection<V>
      Specified by:
      iterator in interface Iterable<V>
      Specified by:
      iterator in interface Set<V>
    • readAll

      public Set<V> readAll()
      Description copied from interface: RSet
      Read all elements at once
      Specified by:
      readAll in interface RSet<V>
      Returns:
      values
    • readAllAsync

      public RFuture<Set<V>> readAllAsync()
      Description copied from interface: RSetAsync
      Read all elements at once
      Specified by:
      readAllAsync in interface RSetAsync<V>
      Returns:
      values
    • toArray

      public Object[] toArray()
      Specified by:
      toArray in interface Collection<V>
      Specified by:
      toArray in interface Set<V>
    • toArray

      public <T> T[] toArray(T[] a)
      Specified by:
      toArray in interface Collection<V>
      Specified by:
      toArray in interface Set<V>
    • add

      public boolean add(V e)
      Specified by:
      add in interface Collection<V>
      Specified by:
      add in interface Set<V>
    • add

      public boolean add(V value, long ttl, TimeUnit unit)
      Description copied from interface: RSetCache
      Stores value with specified time to live. Value expires after specified time to live.
      Specified by:
      add in interface RSetCache<V>
      Parameters:
      value - to add
      ttl - - time to live for key\value entry. If 0 then stores infinitely.
      unit - - time unit
      Returns:
      true if value has been added. false if value already been in collection.
    • addAsync

      public RFuture<Boolean> addAsync(V value, long ttl, TimeUnit unit)
      Description copied from interface: RSetCacheAsync
      Stores value with specified time to live. Value expires after specified time to live.
      Specified by:
      addAsync in interface RSetCacheAsync<V>
      Parameters:
      value - to add
      ttl - - time to live for key\value entry. If 0 then stores infinitely.
      unit - - time unit
      Returns:
      true if value has been added. false if value already been in collection.
    • tryAdd

      public boolean tryAdd(V... values)
      Description copied from interface: RSet
      Tries to add elements only if none of them in set.
      Specified by:
      tryAdd in interface RSet<V>
      Parameters:
      values - - values to add
      Returns:
      true if elements successfully added, otherwise false.
    • tryAddAsync

      public RFuture<Boolean> tryAddAsync(V... values)
      Description copied from interface: RSetAsync
      Tries to add elements only if none of them in set.
      Specified by:
      tryAddAsync in interface RSetAsync<V>
      Parameters:
      values - - values to add
      Returns:
      true if elements successfully added, otherwise false.
    • tryAdd

      public boolean tryAdd(long ttl, TimeUnit unit, V... values)
      Description copied from interface: RSetCache
      Specified by:
      tryAdd in interface RSetCache<V>
      Parameters:
      ttl - - time to live for value. If 0 then stores infinitely.
      unit - - time unit
      values - - values to add
      Returns:
      true if elements successfully added, otherwise false.
    • tryAddAsync

      public RFuture<Boolean> tryAddAsync(long ttl, TimeUnit unit, V... values)
      Description copied from interface: RSetCacheAsync
      Specified by:
      tryAddAsync in interface RSetCacheAsync<V>
      Parameters:
      ttl - - time to live for value. If 0 then stores infinitely.
      unit - - time unit
      values - - values to add
      Returns:
      true if elements successfully added, otherwise false.
    • addAsync

      public RFuture<Boolean> addAsync(V value)
      Description copied from interface: RCollectionAsync
      Adds element into this collection.
      Specified by:
      addAsync in interface RCollectionAsync<V>
      Parameters:
      value - - 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>
      Parameters:
      o - element to be removed from this collection, if present
      Returns:
      true if an element was removed as a result of this call
    • remove

      public boolean remove(Object value)
      Specified by:
      remove in interface Collection<V>
      Specified by:
      remove in interface ScanIterator
      Specified by:
      remove in interface Set<V>
    • containsAll

      public boolean containsAll(Collection<?> c)
      Specified by:
      containsAll in interface Collection<V>
      Specified by:
      containsAll in interface Set<V>
    • 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
    • addAll

      public boolean addAll(Collection<? extends V> c)
      Specified by:
      addAll in interface Collection<V>
      Specified by:
      addAll in interface Set<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
    • retainAll

      public boolean retainAll(Collection<?> c)
      Specified by:
      retainAll in interface Collection<V>
      Specified by:
      retainAll in interface Set<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
    • 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 Set<V>
    • clear

      public void clear()
      Specified by:
      clear in interface Collection<V>
      Specified by:
      clear in interface Set<V>
    • getPermitExpirableSemaphore

      public RPermitExpirableSemaphore getPermitExpirableSemaphore(V value)
      Description copied from interface: RSet
      Returns RPermitExpirableSemaphore instance associated with value
      Specified by:
      getPermitExpirableSemaphore in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RPermitExpirableSemaphore object
    • getSemaphore

      public RSemaphore getSemaphore(V value)
      Description copied from interface: RSet
      Returns RSemaphore instance associated with value
      Specified by:
      getSemaphore in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RSemaphore object
    • getCountDownLatch

      public RCountDownLatch getCountDownLatch(V value)
      Description copied from interface: RSet
      Returns RCountDownLatch instance associated with value
      Specified by:
      getCountDownLatch in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RCountDownLatch object
    • getFairLock

      public RLock getFairLock(V value)
      Description copied from interface: RSet
      Returns RLock instance associated with value
      Specified by:
      getFairLock in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RLock object
    • getLock

      public RLock getLock(V value)
      Description copied from interface: RSet
      Returns lock instance associated with value
      Specified by:
      getLock in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RLock object
    • getReadWriteLock

      public RReadWriteLock getReadWriteLock(V value)
      Description copied from interface: RSet
      Returns RReadWriteLock instance associated with value
      Specified by:
      getReadWriteLock in interface RSet<V>
      Parameters:
      value - - set value
      Returns:
      RReadWriteLock object
    • destroy

      public void destroy()
      Description copied from interface: RDestroyable
      Destroys object when it's not necessary anymore.
      Specified by:
      destroy in interface RDestroyable
    • stream

      public Stream<V> stream(int count)
      Description copied from interface: RSet
      Returns stream of elements fetches elements in a batch. Batch size is defined by count param.
      Specified by:
      stream in interface RSet<V>
      Parameters:
      count - - size of elements batch
      Returns:
      stream of elements
    • stream

      public Stream<V> stream(String pattern, int count)
      Description copied from interface: RSet
      Returns stream of elements fetches elements in a batch. Batch size is defined by count param. If pattern is not null then only elements match this pattern are loaded.
      Specified by:
      stream in interface RSet<V>
      Parameters:
      pattern - - search pattern
      count - - size of elements batch
      Returns:
      stream of elements
    • stream

      public Stream<V> stream(String pattern)
      Description copied from interface: RSet
      Returns stream of elements. If pattern is not null then only elements match this pattern are loaded.
      Specified by:
      stream in interface RSet<V>
      Parameters:
      pattern - - search pattern
      Returns:
      stream of elements
    • addAllCounted

      public int addAllCounted(Collection<? extends V> c)
      Description copied from interface: RSet
      Adds all elements contained in the specified collection. Returns number of added elements.
      Specified by:
      addAllCounted in interface RSet<V>
      Parameters:
      c - - collection of elements to add
      Returns:
      number of added elements
    • removeAllCounted

      public int removeAllCounted(Collection<? extends V> c)
      Description copied from interface: RSet
      Removes all elements contained in the specified collection. Returns number of removed elements.
      Specified by:
      removeAllCounted in interface RSet<V>
      Parameters:
      c - - collection of elements to add
      Returns:
      number of removed elements
    • distributedIterator

      public Iterator<V> distributedIterator(String pattern)
      Description copied from interface: RSet
      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. See RSet.distributedIterator(String, String, int) for creating different iterators.
      Specified by:
      distributedIterator in interface RSet<V>
      Parameters:
      pattern - element pattern
      Returns:
      shared elements iterator
    • distributedIterator

      public Iterator<V> distributedIterator(int count)
      Description copied from interface: RSet
      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 RSet.distributedIterator(String, String, int) for creating different iterators.
      Specified by:
      distributedIterator in interface RSet<V>
      Parameters:
      count - batch size
      Returns:
      shared elements iterator
    • distributedIterator

      public Iterator<V> distributedIterator(String iteratorName, String pattern, int count)
      Description copied from interface: RSet
      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 set name.
      Specified by:
      distributedIterator in interface RSet<V>
      Parameters:
      iteratorName - redis object name to which cursor will be saved
      pattern - element pattern
      count - batch size
      Returns:
      shared elements iterator
    • removeRandom

      public Set<V> removeRandom(int amount)
      Description copied from interface: RSet
      Removes and returns random elements limited by amount
      Specified by:
      removeRandom in interface RSet<V>
      Parameters:
      amount - of random elements
      Returns:
      random elements
    • removeRandom

      public V removeRandom()
      Description copied from interface: RSet
      Removes and returns random element
      Specified by:
      removeRandom in interface RSet<V>
      Returns:
      random element
    • random

      public V random()
      Description copied from interface: RSet
      Returns random element
      Specified by:
      random in interface RSet<V>
      Returns:
      random element
    • random

      public Set<V> random(int count)
      Description copied from interface: RSet
      Returns random elements from set limited by count
      Specified by:
      random in interface RSet<V>
      Parameters:
      count - - values amount to return
      Returns:
      random elements
    • move

      public boolean move(String destination, V member)
      Description copied from interface: RSet
      Move a member from this set to the given destination set in.
      Specified by:
      move in interface RSet<V>
      Parameters:
      destination - the destination set
      member - the member to move
      Returns:
      true if the element is moved, false if the element is not a member of this set or no operation was performed
    • union

      public int union(String... names)
      Description copied from interface: RSet
      Union sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      union in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      size of union
    • readUnion

      public Set<V> readUnion(String... names)
      Description copied from interface: RSet
      Union sets specified by name with current set without current set state change.
      Specified by:
      readUnion in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • diff

      public int diff(String... names)
      Description copied from interface: RSet
      Diff sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      diff in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • readDiff

      public Set<V> readDiff(String... names)
      Description copied from interface: RSet
      Diff sets specified by name with current set. Without current set state change.
      Specified by:
      readDiff in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • intersection

      public int intersection(String... names)
      Description copied from interface: RSet
      Intersection sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      intersection in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      size of intersection
    • readIntersection

      public Set<V> readIntersection(String... names)
      Description copied from interface: RSet
      Intersection sets specified by name with current set without current set state change.
      Specified by:
      readIntersection in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • countIntersection

      public Integer countIntersection(String... names)
      Description copied from interface: RSet
      Counts elements of set as a result of sets intersection with current set.

      Requires Redis 7.0.0 and higher.

      Specified by:
      countIntersection in interface RSet<V>
      Parameters:
      names - - name of sets
      Returns:
      amount of elements
    • countIntersection

      public Integer countIntersection(int limit, String... names)
      Description copied from interface: RSet
      Counts elements of set as a result of sets intersection with current set.

      Requires Redis 7.0.0 and higher.

      Specified by:
      countIntersection in interface RSet<V>
      Parameters:
      limit - - sets intersection limit
      names - - name of sets
      Returns:
      amount of elements
    • containsEach

      public List<V> containsEach(Collection<V> c)
      Description copied from interface: RSet
      Check if each element is contained in the specified collection. Returns contained elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      containsEach in interface RSet<V>
      Parameters:
      c - - collection to check
      Returns:
      contained elements
    • removeRandomAsync

      public RFuture<Set<V>> removeRandomAsync(int amount)
      Description copied from interface: RSetAsync
      Removes and returns random elements from set in async mode
      Specified by:
      removeRandomAsync in interface RSetAsync<V>
      Parameters:
      amount - of random values
      Returns:
      random values
    • removeRandomAsync

      public RFuture<V> removeRandomAsync()
      Description copied from interface: RSetAsync
      Removes and returns random element from set in async mode
      Specified by:
      removeRandomAsync in interface RSetAsync<V>
      Returns:
      value
    • randomAsync

      public RFuture<V> randomAsync()
      Description copied from interface: RSetAsync
      Returns random element from set in async mode
      Specified by:
      randomAsync in interface RSetAsync<V>
      Returns:
      value
    • randomAsync

      public RFuture<Set<V>> randomAsync(int count)
      Description copied from interface: RSetAsync
      Returns random elements from set limited by count
      Specified by:
      randomAsync in interface RSetAsync<V>
      Parameters:
      count - - values amount to return
      Returns:
      value
    • moveAsync

      public RFuture<Boolean> moveAsync(String destination, V member)
      Description copied from interface: RSetAsync
      Move a member from this set to the given destination set in async mode.
      Specified by:
      moveAsync in interface RSetAsync<V>
      Parameters:
      destination - the destination set
      member - the member to move
      Returns:
      true if the element is moved, false if the element is not a member of this set or no operation was performed
    • unionAsync

      public RFuture<Integer> unionAsync(String... names)
      Description copied from interface: RSetAsync
      Union sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      unionAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      size of union
    • readUnionAsync

      public RFuture<Set<V>> readUnionAsync(String... names)
      Description copied from interface: RSetAsync
      Union sets specified by name with current set. Without current set state change.
      Specified by:
      readUnionAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • diffAsync

      public RFuture<Integer> diffAsync(String... names)
      Description copied from interface: RSetAsync
      Diff sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      diffAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      size of diff
    • readDiffAsync

      public RFuture<Set<V>> readDiffAsync(String... names)
      Description copied from interface: RSetAsync
      Diff sets specified by name with current set. Without current set state change.
      Specified by:
      readDiffAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • intersectionAsync

      public RFuture<Integer> intersectionAsync(String... names)
      Description copied from interface: RSetAsync
      Intersection sets specified by name and write to current set. If current set already exists, it is overwritten.
      Specified by:
      intersectionAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      size of intersection
    • readIntersectionAsync

      public RFuture<Set<V>> readIntersectionAsync(String... names)
      Description copied from interface: RSetAsync
      Intersection sets specified by name with current set. Without current set state change.
      Specified by:
      readIntersectionAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      values
    • countIntersectionAsync

      public RFuture<Integer> countIntersectionAsync(String... names)
      Description copied from interface: RSetAsync
      Counts elements of set as a result of sets intersection with current set.

      Requires Redis 7.0.0 and higher.

      Specified by:
      countIntersectionAsync in interface RSetAsync<V>
      Parameters:
      names - - name of sets
      Returns:
      amount of elements
    • countIntersectionAsync

      public RFuture<Integer> countIntersectionAsync(int limit, String... names)
      Description copied from interface: RSetAsync
      Counts elements of set as a result of sets intersection with current set.

      Requires Redis 7.0.0 and higher.

      Specified by:
      countIntersectionAsync in interface RSetAsync<V>
      Parameters:
      limit - - sets intersection limit
      names - - name of sets
      Returns:
      amount of elements
    • addAllCountedAsync

      public RFuture<Integer> addAllCountedAsync(Collection<? extends V> c)
      Description copied from interface: RSetAsync
      Adds all elements contained in the specified collection. Returns number of added elements.
      Specified by:
      addAllCountedAsync in interface RSetAsync<V>
      Parameters:
      c - - collection of elements to add
      Returns:
      number of added elements
    • removeAllCountedAsync

      public RFuture<Integer> removeAllCountedAsync(Collection<? extends V> c)
      Description copied from interface: RSetAsync
      Removes all elements contained in the specified collection. Returns number of removed elements.
      Specified by:
      removeAllCountedAsync in interface RSetAsync<V>
      Parameters:
      c - - collection of elements to add
      Returns:
      number of removed elements
    • containsEachAsync

      public RFuture<List<V>> containsEachAsync(Collection<V> c)
      Description copied from interface: RSetAsync
      Check if each element is contained in the specified collection. Returns contained elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      containsEachAsync in interface RSetAsync<V>
      Parameters:
      c - - collection to check
      Returns:
      contained elements
    • readSort

      public Set<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
    • readSort

      public Set<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
    • readSort

      public Set<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
    • readSort

      public Set<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
    • 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
    • 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
    • readSortAlpha

      public Set<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
    • readSortAlpha

      public Set<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
    • readSortAlpha

      public Set<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
    • readSortAlpha

      public Set<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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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, 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
    • 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
    • readSortAsync

      public RFuture<Set<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
    • readSortAsync

      public RFuture<Set<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
    • readSortAsync

      public RFuture<Set<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
    • readSortAsync

      public RFuture<Set<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
    • 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
    • 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
    • readSortAlphaAsync

      public RFuture<Set<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
    • readSortAlphaAsync

      public RFuture<Set<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
    • readSortAlphaAsync

      public RFuture<Set<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
    • readSortAlphaAsync

      public RFuture<Set<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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • addIfAbsent

      public boolean addIfAbsent(Duration ttl, V object)
      Description copied from interface: RSetCache
      Adds element to this set only if has not been added before.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addIfAbsent in interface RSetCache<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfExists

      public boolean addIfExists(Duration ttl, V object)
      Description copied from interface: RSetCache
      Adds element to this set only if it's already exists.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addIfExists in interface RSetCache<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfLess

      public boolean addIfLess(Duration ttl, V object)
      Description copied from interface: RSetCache
      Adds element to this set only if new ttl less than current ttl of existed element.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addIfLess in interface RSetCache<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfGreater

      public boolean addIfGreater(Duration ttl, V object)
      Description copied from interface: RSetCache
      Adds element to this set only if new ttl greater than current ttl of existed element.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addIfGreater in interface RSetCache<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfAbsentAsync

      public RFuture<Boolean> addIfAbsentAsync(Duration ttl, V object)
      Description copied from interface: RSetCacheAsync
      Adds element to this set only if has not been added before.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addIfAbsentAsync in interface RSetCacheAsync<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfExistsAsync

      public RFuture<Boolean> addIfExistsAsync(Duration ttl, V object)
      Description copied from interface: RSetCacheAsync
      Adds element to this set only if it's already exists.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addIfExistsAsync in interface RSetCacheAsync<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfLessAsync

      public RFuture<Boolean> addIfLessAsync(Duration ttl, V object)
      Description copied from interface: RSetCacheAsync
      Adds element to this set only if new ttl less than current ttl of existed element.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addIfLessAsync in interface RSetCacheAsync<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addIfGreaterAsync

      public RFuture<Boolean> addIfGreaterAsync(Duration ttl, V object)
      Description copied from interface: RSetCacheAsync
      Adds element to this set only if new ttl greater than current ttl of existed element.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addIfGreaterAsync in interface RSetCacheAsync<V>
      Parameters:
      ttl - - object ttl
      object - - object itself
      Returns:
      true if element added and false if not.
    • addAllIfAbsent

      public int addAllIfAbsent(Map<V,Duration> objects)
      Description copied from interface: RSetCache
      Adds elements to this set only if they haven't been added before.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addAllIfAbsent in interface RSetCache<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfExist

      public int addAllIfExist(Map<V,Duration> objects)
      Description copied from interface: RSetCache
      Adds elements to this set only if they already exist.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addAllIfExist in interface RSetCache<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfGreater

      public int addAllIfGreater(Map<V,Duration> objects)
      Description copied from interface: RSetCache
      Adds elements to this set only if new ttl greater than current ttl of existed elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addAllIfGreater in interface RSetCache<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfLess

      public int addAllIfLess(Map<V,Duration> objects)
      Description copied from interface: RSetCache
      Adds elements to this set only if new ttl less than current ttl of existed elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addAllIfLess in interface RSetCache<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfAbsentAsync

      public RFuture<Integer> addAllIfAbsentAsync(Map<V,Duration> objects)
      Description copied from interface: RSetCacheAsync
      Adds elements to this set only if they haven't been added before.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addAllIfAbsentAsync in interface RSetCacheAsync<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfExistAsync

      public RFuture<Integer> addAllIfExistAsync(Map<V,Duration> objects)
      Description copied from interface: RSetCacheAsync
      Adds elements to this set only if they already exist.

      Requires Redis 3.0.2 and higher.

      Specified by:
      addAllIfExistAsync in interface RSetCacheAsync<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfGreaterAsync

      public RFuture<Integer> addAllIfGreaterAsync(Map<V,Duration> objects)
      Description copied from interface: RSetCacheAsync
      Adds elements to this set only if new ttl greater than current ttl of existed elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addAllIfGreaterAsync in interface RSetCacheAsync<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAllIfLessAsync

      public RFuture<Integer> addAllIfLessAsync(Map<V,Duration> objects)
      Description copied from interface: RSetCacheAsync
      Adds elements to this set only if new ttl less than current ttl of existed elements.

      Requires Redis 6.2.0 and higher.

      Specified by:
      addAllIfLessAsync in interface RSetCacheAsync<V>
      Parameters:
      objects - map of elements to add
      Returns:
      amount of added elements
    • addAll

      public int addAll(Map<V,Duration> objects)
      Description copied from interface: RSetCache
      Adds all elements contained in the specified map to this sorted set. Map contains of ttl mapped by object.
      Specified by:
      addAll in interface RSetCache<V>
      Parameters:
      objects - - map of elements to add
      Returns:
      amount of added elements, not including already existing in this sorted set
    • addAllAsync

      public RFuture<Integer> addAllAsync(Map<V,Duration> objects)
      Description copied from interface: RSetCacheAsync
      Adds all elements contained in the specified map to this sorted set. Map contains of ttl mapped by object.
      Specified by:
      addAllAsync in interface RSetCacheAsync<V>
      Parameters:
      objects - - map of elements to add
      Returns:
      amount of added elements, not including already existing in this sorted set
    • 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)