Interface ValueOperations<K,V>

@NullUnmarked public interface ValueOperations<K,V>
Redis operations for simple (or in Redis terminology 'string') values.
Author:
Costin Leau, Christoph Strobl, Mark Paluch, Jiahe Cai, Marcin Grzejszczak, Chris Bono, Yordan Tsintsov

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    append(@NonNull K key, @NonNull String value)
    Append a value to key.
    List<Long>
    bitField(@NonNull K key, @NonNull BitFieldSubCommands subCommands)
    Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
    Boolean
    compareAndSet(@NonNull K key, @NonNull V expectedValue, @NonNull V newValue)
    Compare the value at key with expectedValue and set it to newValue if they are equal.
    Long
    decrement(@NonNull K key)
    Decrement an integer value stored as string value under key by one.
    Long
    decrement(@NonNull K key, long delta)
    Decrement an integer value stored as string value under key by delta.
    String
    get(@NonNull K key, long start, long end)
    Get a substring of value of key between begin and end.
    @Nullable V
    get(Object key)
    Get the value of key.
    @Nullable V
    getAndDelete(@NonNull K key)
    Return the value at key and delete the key.
    @Nullable V
    getAndExpire(@NonNull K key, long timeout, @NonNull TimeUnit unit)
    Deprecated.
    since 4.1 in favor of getAndExpire(Object, Expiration).
    @Nullable V
    getAndExpire(@NonNull K key, @NonNull Duration timeout)
    Return the value at key and expire the key by applying timeout.
    V
    getAndExpire(@NonNull K key, @NonNull Expiration expiration)
    Return the value at key and expire the key by applying expiration.
    @Nullable V
    getAndPersist(@NonNull K key)
    Return the value at key and persist the key.
    @Nullable V
    getAndSet(@NonNull K key, @NonNull V value)
    Set value of key and return its old value.
    Boolean
    getBit(@NonNull K key, long offset)
    Get the bit value at offset of value at key.
    @NonNull RedisOperations<K,V>
    getOperations()
     
    Long
    increment(@NonNull K key)
    Increment an integer value stored as string value under key by one.
    Double
    increment(@NonNull K key, double delta)
    Increment a floating point number value stored as string value under key by delta.
    Long
    increment(@NonNull K key, long delta)
    Increment an integer value stored as string value under key by delta.
    List<@Nullable V>
    multiGet(@NonNull Collection<@NonNull K> keys)
    Get multiple keys.
    void
    multiSet(Map<? extends @NonNull K, ? extends @NonNull V> map)
    Set multiple keys to multiple values using key-value pairs provided in tuple.
    Boolean
    multiSetIfAbsent(Map<? extends @NonNull K, ? extends @NonNull V> map)
    Set multiple keys to multiple values using key-value pairs provided in tuple only if the provided key does not exist.
    void
    set(@NonNull K key, @NonNull V value)
    Set value for key.
    void
    set(@NonNull K key, @NonNull V value, long offset)
    Overwrite parts of key starting at the specified offset with given value.
    default void
    set(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
    Deprecated.
    since 4.1 in favor of set(Object, Object, Expiration)
    default void
    set(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
    Set the value and expiration timeout for key.
    Boolean
    set(@NonNull K key, @NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)
    Set value for key and customize the operation through SetSpec.
    void
    set(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
    Set the value and expiration for key.
    Boolean
    setBit(@NonNull K key, long offset, boolean value)
    Sets the bit at offset in value stored at key.
    default @Nullable V
    setGet(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
    Deprecated.
    since 4.1 in favor of setGet(Object, Object, Expiration).
    default @Nullable V
    setGet(@NonNull K key, @NonNull V value, @NonNull Duration duration)
    Set the value and expiration timeout for key.
    V
    setGet(@NonNull K key, @NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)
    Set value for key and customize the operation through SetSpec.
    @Nullable V
    setGet(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
    Set the value and expiration for key.
    default Boolean
    setIfAbsent(@NonNull K key, @NonNull V value)
    Set the value for key if key is absent.
    default Boolean
    setIfAbsent(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
    Deprecated.
    since 4.1 in favor of setIfAbsent(Object, Object, Expiration).
    default Boolean
    setIfAbsent(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
    Set the value and expiration timeout for key if key is absent.
    Boolean
    setIfAbsent(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
    Set the value and expiration for key if key is absent.
    default Boolean
    setIfPresent(@NonNull K key, @NonNull V value)
    Set the value for key if key is present.
    default Boolean
    setIfPresent(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
    Deprecated.
    since 4.1 in favor of setIfPresent(Object, Object, Expiration).
    default Boolean
    setIfPresent(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
    Set the value and expiration timeout for key if key is present.
    Boolean
    setIfPresent(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
    Set the value and expiration for key if key is present.
    Long
    size(@NonNull K key)
    Get the length of the value stored at key.

  • Method Details

    • set

      void set(@NonNull K key, @NonNull V value)
      Set value for key.
      Parameters:
      key - must not be null.
      value - must not be null.
      See Also:

    • set

      void set(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
      Set the value and expiration for key.
      Parameters:
      key - must not be null.
      value - must not be null.
      expiration - must not be null.
      Since:
      4.1
      See Also:

    • set

      @Deprecated(since="4.1") default void set(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
      Deprecated.
      since 4.1 in favor of set(Object, Object, Expiration)
      Set the value and expiration timeout for key.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - the key expiration timeout.
      unit - must not be null.
      See Also:

    • set

      default void set(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
      Set the value and expiration timeout for key.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - must not be null.
      Throws:
      IllegalArgumentException - if either key, value or timeout is not present.
      Since:
      2.1
      See Also:

    • set

      Boolean set(@NonNull K key, @NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)
      Set value for key and customize the operation through SetSpec.
      Parameters:
      key - must not be null.
      value - must not be null.
      setConsumer - a function that consumes the SetSpec to configure the set operation, must not be null.
      Returns:
      true if the operation was successful, false otherwise. null when used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • setGet

      @Nullable V setGet(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
      Set the value and expiration for key. Return the old string stored at key, or null if key did not exist. An error is returned and SET aborted if the value stored at key is not a string.
      Parameters:
      key - must not be null.
      value - must not be null.
      expiration - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • setGet

      @Deprecated(since="4.1") default @Nullable V setGet(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
      Deprecated.
      since 4.1 in favor of setGet(Object, Object, Expiration).
      Set the value and expiration timeout for key. Return the old string stored at key, or null if key did not exist. An error is returned and SET aborted if the value stored at key is not a string.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - the key expiration timeout.
      unit - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      3.5
      See Also:

    • setGet

      default @Nullable V setGet(@NonNull K key, @NonNull V value, @NonNull Duration duration)
      Set the value and expiration timeout for key. Return the old string stored at key, or null if key did not exist. An error is returned and SET aborted if the value stored at key is not a string.
      Parameters:
      key - must not be null.
      value - must not be null.
      duration - expiration duration
      Returns:
      null when used in pipeline / transaction.
      Since:
      3.5
      See Also:

    • setGet

      V setGet(@NonNull K key, @NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)
      Set value for key and customize the operation through SetSpec. Return the old string stored at key, or null if key did not exist.
      Parameters:
      key - must not be null.
      value - must not be null.
      setConsumer - a function that consumes the SetSpec to configure the set operation, must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • setIfAbsent

      default Boolean setIfAbsent(@NonNull K key, @NonNull V value)
      Set the value for key if key is absent.
      Parameters:
      key - must not be null.
      value - must not be null.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • setIfAbsent

      Boolean setIfAbsent(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
      Set the value and expiration for key if key is absent.
      Parameters:
      key - must not be null.
      value - must not be null.
      expiration - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • setIfAbsent

      @Deprecated(since="4.1") default Boolean setIfAbsent(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
      Deprecated.
      since 4.1 in favor of setIfAbsent(Object, Object, Expiration).
      Set the value and expiration timeout for key if key is absent.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - the key expiration timeout.
      unit - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • setIfAbsent

      default Boolean setIfAbsent(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
      Set the value and expiration timeout for key if key is absent.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Throws:
      IllegalArgumentException - if either key, value or timeout is not present.
      Since:
      2.1
      See Also:

    • setIfPresent

      default Boolean setIfPresent(@NonNull K key, @NonNull V value)
      Set the value for key if key is present.
      Parameters:
      key - must not be null.
      value - must not be null.
      Returns:
      command result indicating if the key has been set.
      Throws:
      IllegalArgumentException - if either key or value is not present.
      Since:
      2.1
      See Also:

    • setIfPresent

      Boolean setIfPresent(@NonNull K key, @NonNull V value, @NonNull Expiration expiration)
      Set the value and expiration for key if key is present.
      Parameters:
      key - must not be null.
      value - must not be null.
      expiration - must not be null.
      Returns:
      command result indicating if the key has been set.
      Since:
      4.1
      See Also:

    • setIfPresent

      @Deprecated(since="4.1") default Boolean setIfPresent(@NonNull K key, @NonNull V value, long timeout, @NonNull TimeUnit unit)
      Deprecated.
      since 4.1 in favor of setIfPresent(Object, Object, Expiration).
      Set the value and expiration timeout for key if key is present.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - the key expiration timeout.
      unit - must not be null.
      Returns:
      command result indicating if the key has been set.
      Throws:
      IllegalArgumentException - if either key, value or timeout is not present.
      Since:
      2.1
      See Also:

    • setIfPresent

      default Boolean setIfPresent(@NonNull K key, @NonNull V value, @NonNull Duration timeout)
      Set the value and expiration timeout for key if key is present.
      Parameters:
      key - must not be null.
      value - must not be null.
      timeout - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Throws:
      IllegalArgumentException - if either key, value or timeout is not present.
      Since:
      2.1
      See Also:

    • compareAndSet

      Boolean compareAndSet(@NonNull K key, @NonNull V expectedValue, @NonNull V newValue)
      Compare the value at key with expectedValue and set it to newValue if they are equal. Use set(Object, Object, Consumer) to customize the set operation using e.g. a different value comparison strategy.
      Parameters:
      key - must not be null.
      expectedValue - the expected current value, must not be null.
      newValue - the new value to set if comparison succeeds, must not be null.
      Returns:
      true if the operation was successful, false otherwise. null when used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • multiSet

      void multiSet(Map<? extends @NonNull K, ? extends @NonNull V> map)
      Set multiple keys to multiple values using key-value pairs provided in tuple.
      Parameters:
      map - must not be null.
      See Also:

    • multiSetIfAbsent

      Boolean multiSetIfAbsent(Map<? extends @NonNull K, ? extends @NonNull V> map)
      Set multiple keys to multiple values using key-value pairs provided in tuple only if the provided key does not exist.
      Parameters:
      map - must not be null.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • get

      @Nullable V get(Object key)
      Get the value of key.
      Parameters:
      key - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      See Also:

    • getAndDelete

      @Nullable V getAndDelete(@NonNull K key)
      Return the value at key and delete the key.
      Parameters:
      key - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      2.6
      See Also:

    • getAndExpire

      V getAndExpire(@NonNull K key, @NonNull Expiration expiration)
      Return the value at key and expire the key by applying expiration.
      Parameters:
      key - must not be null.
      expiration - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      4.1
      See Also:

    • getAndExpire

      @Deprecated(since="4.1") @Nullable V getAndExpire(@NonNull K key, long timeout, @NonNull TimeUnit unit)
      Deprecated.
      since 4.1 in favor of getAndExpire(Object, Expiration).
      Return the value at key and expire the key by applying timeout.
      Parameters:
      key - must not be null.
      timeout -
      unit - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      2.6
      See Also:

    • getAndExpire

      @Nullable V getAndExpire(@NonNull K key, @NonNull Duration timeout)
      Return the value at key and expire the key by applying timeout.
      Parameters:
      key - must not be null.
      timeout - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      2.6
      See Also:

    • getAndPersist

      @Nullable V getAndPersist(@NonNull K key)
      Return the value at key and persist the key. This operation removes any TTL that is associated with key.
      Parameters:
      key - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      2.6
      See Also:

    • getAndSet

      @Nullable V getAndSet(@NonNull K key, @NonNull V value)
      Set value of key and return its old value.
      Parameters:
      key - must not be null.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      See Also:

    • multiGet

      List<@Nullable V> multiGet(@NonNull Collection<@NonNull K> keys)
      Get multiple keys. Values are in the order of the requested keys Absent field values are represented using null in the resulting List.
      Parameters:
      keys - must not be null.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • increment

      Long increment(@NonNull K key)
      Increment an integer value stored as string value under key by one.
      Parameters:
      key - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • increment

      Long increment(@NonNull K key, long delta)
      Increment an integer value stored as string value under key by delta.
      Parameters:
      key - must not be null.
      delta -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • increment

      Double increment(@NonNull K key, double delta)
      Increment a floating point number value stored as string value under key by delta.
      Parameters:
      key - must not be null.
      delta -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • decrement

      Long decrement(@NonNull K key)
      Decrement an integer value stored as string value under key by one.
      Parameters:
      key - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • decrement

      Long decrement(@NonNull K key, long delta)
      Decrement an integer value stored as string value under key by delta.
      Parameters:
      key - must not be null.
      delta -
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • append

      Integer append(@NonNull K key, @NonNull String value)
      Append a value to key.
      Parameters:
      key - must not be null.
      value -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • get

      String get(@NonNull K key, long start, long end)
      Get a substring of value of key between begin and end.
      Parameters:
      key - must not be null.
      start -
      end -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • set

      void set(@NonNull K key, @NonNull V value, long offset)
      Overwrite parts of key starting at the specified offset with given value.
      Parameters:
      key - must not be null.
      value -
      offset -
      See Also:

    • size

      Long size(@NonNull K key)
      Get the length of the value stored at key.
      Parameters:
      key - must not be null.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • setBit

      Boolean setBit(@NonNull K key, long offset, boolean value)
      Sets the bit at offset in value stored at key.
      Parameters:
      key - must not be null.
      offset -
      value -
      Returns:
      null when used in pipeline / transaction.
      Since:
      1.5
      See Also:

    • getBit

      Boolean getBit(@NonNull K key, long offset)
      Get the bit value at offset of value at key.
      Parameters:
      key - must not be null.
      offset -
      Returns:
      null when used in pipeline / transaction.
      Since:
      1.5
      See Also:

    • bitField

      List<Long> bitField(@NonNull K key, @NonNull BitFieldSubCommands subCommands)
      Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
      Parameters:
      key - must not be null.
      subCommands - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • getOperations

      @NonNull RedisOperations<K,V> getOperations()
      Returns:
      the underlying RedisOperations used to execute commands.