Package org.redisson.transaction

Class RedissonTransactionalSet<V>

java.lang.Object
org.redisson.RedissonObject
org.redisson.RedissonSet<V>
org.redisson.transaction.RedissonTransactionalSet<V>
Type Parameters:
V - value type
All Implemented Interfaces:
Iterable<V>, Collection<V>, Set<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RSet<V>, RSetAsync<V>, RSortable<Set<V>>, RSortableAsync<Set<V>>, ScanIterator
public class RedissonTransactionalSet<V> extends RedissonSet<V>
Author:
Nikita Koksharov

  • Constructor Details

  • Method Details

    • expireAsync

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

    • expireAtAsync

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

    • 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

    • moveAsync

      public RFuture<Boolean> moveAsync(int database)
      Description copied from interface: RObjectAsync
      Move object to another database in async mode
      Specified by:
      moveAsync in interface RObjectAsync
      Overrides:
      moveAsync in class RedissonObject
      Parameters:
      database - - number of Redis database
      Returns:
      true if key was moved false if not

    • migrateAsync

      public RFuture<Void> migrateAsync(String host, int port, int database, long timeout)
      Description copied from interface: RObjectAsync
      Transfer object from source Redis instance to destination Redis instance in async mode
      Specified by:
      migrateAsync in interface RObjectAsync
      Overrides:
      migrateAsync in class RedissonObject
      Parameters:
      host - - destination host
      port - - destination port
      database - - destination database
      timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds
      Returns:
      void

    • 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>
      Overrides:
      mapReduce in class RedissonSet<V>
      Type Parameters:
      KOut - output key
      VOut - output value
      Returns:
      MapReduce instance

    • scanIterator

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

    • getFairLock

      public RLock getFairLock(V value)
      Description copied from interface: RSet
      Returns RLock instance associated with value
      Specified by:
      getFairLock in interface RSet<V>
      Overrides:
      getFairLock in class RedissonSet<V>
      Parameters:
      value - - set value
      Returns:
      RLock 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>
      Overrides:
      getCountDownLatch in class RedissonSet<V>
      Parameters:
      value - - set value
      Returns:
      RCountDownLatch object

    • getPermitExpirableSemaphore

      public RPermitExpirableSemaphore getPermitExpirableSemaphore(V value)
      Description copied from interface: RSet
      Returns RPermitExpirableSemaphore instance associated with value
      Specified by:
      getPermitExpirableSemaphore in interface RSet<V>
      Overrides:
      getPermitExpirableSemaphore in class RedissonSet<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>
      Overrides:
      getSemaphore in class RedissonSet<V>
      Parameters:
      value - - set value
      Returns:
      RSemaphore 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>
      Overrides:
      getLock in class RedissonSet<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>
      Overrides:
      getReadWriteLock in class RedissonSet<V>
      Parameters:
      value - - set value
      Returns:
      RReadWriteLock object

    • 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>
      Overrides:
      containsAsync in class RedissonSet<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

    • readAllAsync

      public RFuture<Set<V>> readAllAsync()
      Description copied from interface: RSetAsync
      Read all elements at once
      Specified by:
      readAllAsync in interface RSetAsync<V>
      Overrides:
      readAllAsync in class RedissonSet<V>
      Returns:
      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 RedissonSet<V>
      Parameters:
      e - - element to add
      Returns:
      true if an element was added and false if it is already present

    • 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>
      Overrides:
      removeRandomAsync in class RedissonSet<V>
      Returns:
      value

    • 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>
      Overrides:
      removeRandomAsync in class RedissonSet<V>
      Parameters:
      amount - of random values
      Returns:
      random values

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

    • 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>
      Overrides:
      moveAsync in class RedissonSet<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

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

    • 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 RedissonSet<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>
      Overrides:
      removeAllAsync in class RedissonSet<V>
      Parameters:
      c - collection containing elements to be removed from this collection
      Returns:
      true if this collection changed as a result of the call

    • 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>
      Overrides:
      unionAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      size of union

    • 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>
      Overrides:
      diffAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      size of diff

    • 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>
      Overrides:
      intersectionAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      size of intersection

    • 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>
      Overrides:
      readSortAsync in class RedissonSet<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>
      Overrides:
      readSortAsync in class RedissonSet<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>
      Overrides:
      readSortAsync in class RedissonSet<V>
      Parameters:
      byPattern - that is used to generate the keys that are used for sorting
      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>
      Overrides:
      readSortAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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>
      Overrides:
      readSortAlphaAsync in class RedissonSet<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, 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>
      Overrides:
      sortToAsync in class RedissonSet<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

    • 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>
      Overrides:
      readUnionAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values

    • 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>
      Overrides:
      readDiffAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values

    • 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>
      Overrides:
      readIntersectionAsync in class RedissonSet<V>
      Parameters:
      names - - name of sets
      Returns:
      values

    • unlinkAsync

      public RFuture<Boolean> unlinkAsync()
      Description copied from interface: RObjectAsync
      Delete the objects. Actual removal will happen later asynchronously.

      Requires Redis 4.0+

      Specified by:
      unlinkAsync in interface RObjectAsync
      Overrides:
      unlinkAsync in class RedissonObject
      Returns:
      true if it was exist and deleted else false

    • touchAsync

      public RFuture<Boolean> touchAsync()
      Description copied from interface: RObjectAsync
      Update the last access time of an object in async mode.
      Specified by:
      touchAsync in interface RObjectAsync
      Overrides:
      touchAsync in class RedissonObject
      Returns:
      true if object was touched else false

    • deleteAsync

      public RFuture<Boolean> deleteAsync()
      Description copied from interface: RObjectAsync
      Delete object in async mode
      Specified by:
      deleteAsync in interface RObjectAsync
      Overrides:
      deleteAsync in class RedissonObject
      Returns:
      true if object was deleted false if not

    • checkState

      protected void checkState()

    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Duration) instead
      Specified by:
      expire in interface RExpirable
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Duration) instead
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not

    • expireAt

      public boolean expireAt(long timestamp)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Instant) instead
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not

    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(long timestamp)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Instant) instead
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not

    • expire

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

    • expireIfSet

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfSetAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfNotSet

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfNotSetAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfGreater

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfGreaterAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfLess

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfLessAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireAsync

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

    • expire

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

    • expireAsync

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

    • expireAt

      public boolean expireAt(Date timestamp)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Instant) instead
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(Date timestamp)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Instant) instead
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfSetAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfNotSet

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfNotSetAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfGreater

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfGreaterAsync

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfLess

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

      Requires Redis 7.0.0 and higher.

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

    • expireIfLessAsync

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

      Requires Redis 7.0.0 and higher.

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

    • clearExpire

      public boolean clearExpire()
      Description copied from interface: RExpirable
      Clear an expire timeout or expire date for object.
      Specified by:
      clearExpire in interface RExpirable
      Returns:
      true if timeout was removed false if object does not exist or does not have an associated timeout

    • 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

    • clearExpireAsync

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