Package org.redisson

Class RedissonBucket<V>

java.lang.Object
org.redisson.RedissonObject
org.redisson.RedissonBucket<V>
Type Parameters:
V - value type
All Implemented Interfaces:
RBucket<V>, RBucketAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync
Direct Known Subclasses:
ExpireAtOperation.RedissonBucketExtended, ExpireOperation.RedissonBucketExtended, RedissonBinaryStream, RedissonTransactionalBucket

public class RedissonBucket<V> extends RedissonObject implements RBucket<V>
Author:
Nikita Koksharov
  • Constructor Details

  • Method Details

    • compareAndSet

      public boolean compareAndSet(V expect, V update)
      Description copied from interface: RBucket
      Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
      Specified by:
      compareAndSet in interface RBucket<V>
      Parameters:
      expect - the expected value
      update - the new value
      Returns:
      true if successful; or false if the actual value was not equal to the expected value.
    • compareAndSetAsync

      public RFuture<Boolean> compareAndSetAsync(V expect, V update)
      Description copied from interface: RBucketAsync
      Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
      Specified by:
      compareAndSetAsync in interface RBucketAsync<V>
      Parameters:
      expect - the expected value
      update - the new value
      Returns:
      true if successful; or false if the actual value was not equal to the expected value.
    • getAndSet

      public V getAndSet(V newValue)
      Description copied from interface: RBucket
      Retrieves current element in the holder and replaces it with newValue.
      Specified by:
      getAndSet in interface RBucket<V>
      Parameters:
      newValue - - value to set
      Returns:
      previous value
    • getAndSetAsync

      public RFuture<V> getAndSetAsync(V newValue)
      Description copied from interface: RBucketAsync
      Retrieves current element in the holder and replaces it with newValue.
      Specified by:
      getAndSetAsync in interface RBucketAsync<V>
      Parameters:
      newValue - - value to set
      Returns:
      previous value
    • getAndExpire

      public V getAndExpire(Instant time)
      Description copied from interface: RBucket
      Retrieves current element in the holder and sets an expiration date for it.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndExpire in interface RBucket<V>
      Parameters:
      time - of exact object expiration moment
      Returns:
      element
    • getAndExpireAsync

      public RFuture<V> getAndExpireAsync(Instant time)
      Description copied from interface: RBucketAsync
      Retrieves current element in the holder and sets an expiration date for it.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndExpireAsync in interface RBucketAsync<V>
      Parameters:
      time - of exact object expiration moment
      Returns:
      element
    • getAndExpire

      public V getAndExpire(Duration duration)
      Description copied from interface: RBucket
      Retrieves current element in the holder and sets an expiration duration for it.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndExpire in interface RBucket<V>
      Parameters:
      duration - of object time to live interval
      Returns:
      element
    • getAndExpireAsync

      public RFuture<V> getAndExpireAsync(Duration duration)
      Description copied from interface: RBucketAsync
      Retrieves current element in the holder and sets an expiration duration for it.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndExpireAsync in interface RBucketAsync<V>
      Parameters:
      duration - of object time to live interval
      Returns:
      element
    • getAndClearExpire

      public V getAndClearExpire()
      Description copied from interface: RBucket
      Retrieves current element in the holder and clears expiration date set before.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndClearExpire in interface RBucket<V>
      Returns:
      element
    • getAndClearExpireAsync

      public RFuture<V> getAndClearExpireAsync()
      Description copied from interface: RBucketAsync
      Retrieves current element in the holder and clears expiration date set before.

      Requires Redis 6.2.0 and higher.

      Specified by:
      getAndClearExpireAsync in interface RBucketAsync<V>
      Returns:
      element
    • get

      public V get()
      Description copied from interface: RBucket
      Retrieves element stored in the holder.
      Specified by:
      get in interface RBucket<V>
      Returns:
      element
    • getAsync

      public RFuture<V> getAsync()
      Description copied from interface: RBucketAsync
      Retrieves element stored in the holder.
      Specified by:
      getAsync in interface RBucketAsync<V>
      Returns:
      element
    • getAndDelete

      public V getAndDelete()
      Description copied from interface: RBucket
      Retrieves element in the holder and removes it.
      Specified by:
      getAndDelete in interface RBucket<V>
      Returns:
      element
    • getAndDeleteAsync

      public RFuture<V> getAndDeleteAsync()
      Description copied from interface: RBucketAsync
      Retrieves element in the holder and removes it.
      Specified by:
      getAndDeleteAsync in interface RBucketAsync<V>
      Returns:
      element
    • size

      public long size()
      Description copied from interface: RBucket
      Returns size of object in bytes.
      Specified by:
      size in interface RBucket<V>
      Returns:
      object size
    • sizeAsync

      public RFuture<Long> sizeAsync()
      Description copied from interface: RBucketAsync
      Returns size of object in bytes
      Specified by:
      sizeAsync in interface RBucketAsync<V>
      Returns:
      object size
    • set

      public void set(V value)
      Description copied from interface: RBucket
      Stores element into the holder.
      Specified by:
      set in interface RBucket<V>
      Parameters:
      value - - value to set
    • setAsync

      public RFuture<Void> setAsync(V value)
      Description copied from interface: RBucketAsync
      Stores element into the holder.
      Specified by:
      setAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      Returns:
      void
    • set

      public void set(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucket
      Specified by:
      set in interface RBucket<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
    • setAsync

      public RFuture<Void> setAsync(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucketAsync
      Specified by:
      setAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      void
    • set

      public void set(V value, Duration duration)
      Description copied from interface: RBucket
      Stores value into the holder with defined expiration duration.
      Specified by:
      set in interface RBucket<V>
      Parameters:
      value - value to set
      duration - expiration duration
    • setAsync

      public RFuture<Void> setAsync(V value, Duration duration)
      Description copied from interface: RBucketAsync
      Stores value into the holder with defined expiration duration.
      Specified by:
      setAsync in interface RBucketAsync<V>
      Parameters:
      value - value to set
      duration - expiration duration
    • trySetAsync

      public RFuture<Boolean> trySetAsync(V value)
      Description copied from interface: RBucketAsync
      Specified by:
      trySetAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element was already set
    • trySetAsync

      public RFuture<Boolean> trySetAsync(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucketAsync
      Specified by:
      trySetAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      true if successful, or false if element was already set
    • trySet

      public boolean trySet(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucket
      Specified by:
      trySet in interface RBucket<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      true if successful, or false if element was already set
    • trySet

      public boolean trySet(V value)
      Description copied from interface: RBucket
      Specified by:
      trySet in interface RBucket<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element was already set
    • setIfAbsent

      public boolean setIfAbsent(V value)
      Description copied from interface: RBucket
      Sets value only if object holder doesn't exist.
      Specified by:
      setIfAbsent in interface RBucket<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element was already set
    • setIfAbsent

      public boolean setIfAbsent(V value, Duration duration)
      Description copied from interface: RBucket
      Sets value with defined duration only if object holder doesn't exist.
      Specified by:
      setIfAbsent in interface RBucket<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      true if successful, or false if element was already set
    • setIfAbsentAsync

      public RFuture<Boolean> setIfAbsentAsync(V value)
      Description copied from interface: RBucketAsync
      Sets value only if object holder doesn't exist.
      Specified by:
      setIfAbsentAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element was already set
    • setIfAbsentAsync

      public RFuture<Boolean> setIfAbsentAsync(V value, Duration duration)
      Description copied from interface: RBucketAsync
      Sets value with defined duration only if object holder doesn't exist.
      Specified by:
      setIfAbsentAsync in interface RBucketAsync<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      true if successful, or false if element was already set
    • setIfExists

      public boolean setIfExists(V value)
      Description copied from interface: RBucket
      Sets value only if object holder already exists.
      Specified by:
      setIfExists in interface RBucket<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element wasn't set
    • setIfExistsAsync

      public RFuture<Boolean> setIfExistsAsync(V value)
      Description copied from interface: RBucketAsync
      Sets value only if it's already exists.
      Specified by:
      setIfExistsAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      Returns:
      true if successful, or false if element wasn't set
    • setAndKeepTTL

      public void setAndKeepTTL(V value)
      Description copied from interface: RBucket
      Set value and keep existing TTL.

      Requires Redis 6.0.0 and higher.

      Specified by:
      setAndKeepTTL in interface RBucket<V>
      Parameters:
      value - - value to set
    • setAndKeepTTLAsync

      public RFuture<Void> setAndKeepTTLAsync(V value)
      Description copied from interface: RBucketAsync
      Set value and keep existing TTL.

      Requires Redis 6.0.0 and higher.

      Specified by:
      setAndKeepTTLAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      Returns:
      void
    • setIfExists

      public boolean setIfExists(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucket
      Specified by:
      setIfExists in interface RBucket<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      true if successful, or false if element wasn't set
    • setIfExistsAsync

      public RFuture<Boolean> setIfExistsAsync(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucketAsync
      Specified by:
      setIfExistsAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      true if successful, or false if element wasn't set
    • setIfExists

      public boolean setIfExists(V value, Duration duration)
      Description copied from interface: RBucket
      Sets value with expiration duration only if object holder already exists.
      Specified by:
      setIfExists in interface RBucket<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      true if successful, or false if element wasn't set
    • setIfExistsAsync

      public RFuture<Boolean> setIfExistsAsync(V value, Duration duration)
      Description copied from interface: RBucketAsync
      Sets value with expiration duration only if object holder already exists.
      Specified by:
      setIfExistsAsync in interface RBucketAsync<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      true if successful, or false if element wasn't set
    • getAndSet

      public V getAndSet(V value, Duration duration)
      Description copied from interface: RBucket
      Retrieves current element in the holder and replaces it with value with defined expiration duration.
      Specified by:
      getAndSet in interface RBucket<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      previous value
    • getAndSetAsync

      public RFuture<V> getAndSetAsync(V value, Duration duration)
      Description copied from interface: RBucketAsync
      Retrieves current element in the holder and replaces it with value with defined expiration duration.
      Specified by:
      getAndSetAsync in interface RBucketAsync<V>
      Parameters:
      value - value to set
      duration - expiration duration
      Returns:
      previous value
    • getAndSetAsync

      public RFuture<V> getAndSetAsync(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucketAsync
      Specified by:
      getAndSetAsync in interface RBucketAsync<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      previous value
    • getAndSet

      public V getAndSet(V value, long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RBucket
      Specified by:
      getAndSet in interface RBucket<V>
      Parameters:
      value - - value to set
      timeToLive - - time to live interval
      timeUnit - - unit of time to live interval
      Returns:
      previous value
    • addListener

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

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

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

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