Package org.springframework.data.redis.core

Interface BoundValueOperations<K,V>

All Superinterfaces:
BoundKeyOperations<K>
public interface BoundValueOperations<K,V> extends BoundKeyOperations<K>
Value (or String in Redis terminology) operations bound to a certain key.
Author:
Costin Leau, Mark Paluch, Jiahe Cai, Christoph Strobl

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    append(String value)
    Append a value to the bound key.
    Long
    decrement()
    Decrement an integer value stored as string value under the bound key by one.
    Long
    decrement(long delta)
    Decrement an integer value stored as string value under the bound key by delta.
    V
    get()
    Get the value of the bound key.
    String
    get(long start, long end)
    Get a substring of value of the bound key between begin and end.
    V
    getAndDelete()
    Return the value at the bound key and delete the key.
    V
    getAndExpire(long timeout, TimeUnit unit)
    Return the value at the bound key and expire the key by applying timeout.
    V
    getAndExpire(Duration timeout)
    Return the value at the bound key and expire the key by applying timeout.
    V
    getAndPersist()
    Return the value at the bound key and persist the key.
    V
    getAndSet(V value)
    Set value of the bound key and return its old value.
    RedisOperations<K,V>
    getOperations()
     
    Long
    increment()
    Increment an integer value stored as string value under the bound key by one.
    Double
    increment(double delta)
    Increment a floating point number value stored as string value under the bound key by delta.
    Long
    increment(long delta)
    Increment an integer value stored as string value under the bound key by delta.
    void
    set(V value)
    Set value for the bound key.
    void
    set(V value, long offset)
    Overwrite parts of the bound key starting at the specified offset with given value.
    void
    set(V value, long timeout, TimeUnit unit)
    Set the value and expiration timeout for the bound key.
    default void
    set(V value, Duration timeout)
    Set the value and expiration timeout for the bound key.
    Boolean
    setIfAbsent(V value)
    Set the bound key to hold the string value if the bound key is absent.
    Boolean
    setIfAbsent(V value, long timeout, TimeUnit unit)
    Set the bound key to hold the string value and expiration timeout if the bound key is absent.
    default Boolean
    setIfAbsent(V value, Duration timeout)
    Set bound key to hold the string value and expiration timeout if the bound key is absent.
    Boolean
    setIfPresent(V value)
    Set the bound key to hold the string value if the bound key is present.
    Boolean
    setIfPresent(V value, long timeout, TimeUnit unit)
    Set the bound key to hold the string value and expiration timeout if the bound key is present.
    default Boolean
    setIfPresent(V value, Duration timeout)
    Set the bound key to hold the string value and expiration timeout if the bound key is present.
    Long
    size()
    Get the length of the value stored at the bound key.

    Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

    expire, expire, expireAt, expireAt, getExpire, getKey, getType, persist, rename

  • Method Details

    • set

      void set(V value)
      Set value for the bound key.
      Parameters:
      value - must not be null.
      See Also:

    • set

      void set(V value, long timeout, TimeUnit unit)
      Set the value and expiration timeout for the bound key.
      Parameters:
      value - must not be null.
      timeout -
      unit - must not be null.
      See Also:

    • set

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

    • setIfAbsent

      @Nullable Boolean setIfAbsent(V value)
      Set the bound key to hold the string value if the bound key is absent.
      Parameters:
      value - must not be null.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • setIfAbsent

      @Nullable Boolean setIfAbsent(V value, long timeout, TimeUnit unit)
      Set the bound key to hold the string value and expiration timeout if the bound key is absent.
      Parameters:
      value - must not be null.
      timeout -
      unit - must not be null.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • setIfAbsent

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

    • setIfPresent

      @Nullable Boolean setIfPresent(V value)
      Set the bound key to hold the string value if the bound key is present.
      Parameters:
      value - must not be null.
      Returns:
      command result indicating if the key has been set.
      Throws:
      IllegalArgumentException - if value is not present.
      Since:
      2.1
      See Also:

    • setIfPresent

      @Nullable Boolean setIfPresent(V value, long timeout, TimeUnit unit)
      Set the bound key to hold the string value and expiration timeout if the bound key is present.
      Parameters:
      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 value or timeout is not present.
      Since:
      2.1
      See Also:

    • setIfPresent

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

    • get

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

    • getAndDelete

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

    • getAndExpire

      @Nullable V getAndExpire(long timeout, TimeUnit unit)
      Return the value at the bound key and expire the key by applying timeout.
      Parameters:
      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(Duration timeout)
      Return the value at the bound key and expire the key by applying timeout.
      Parameters:
      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()
      Return the value at the bound key and persist the key. This operation removes any TTL that is associated with the bound key.
      Returns:
      null when key does not exist or used in pipeline / transaction.
      Since:
      2.6
      See Also:

    • getAndSet

      @Nullable V getAndSet(V value)
      Set value of the bound key and return its old value.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • increment

      @Nullable Long increment()
      Increment an integer value stored as string value under the bound key by one.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • increment

      @Nullable Long increment(long delta)
      Increment an integer value stored as string value under the bound key by delta.
      Parameters:
      delta -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • increment

      @Nullable Double increment(double delta)
      Increment a floating point number value stored as string value under the bound key by delta.
      Parameters:
      delta -
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • decrement

      @Nullable Long decrement()
      Decrement an integer value stored as string value under the bound key by one.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • decrement

      @Nullable Long decrement(long delta)
      Decrement an integer value stored as string value under the bound key by delta.
      Parameters:
      delta -
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.1
      See Also:

    • append

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

    • get

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

    • set

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

    • size

      @Nullable Long size()
      Get the length of the value stored at the bound key.
      Returns:
      null when used in pipeline / transaction.
      See Also:

    • getOperations

      RedisOperations<K,V> getOperations()
      Returns:
      never null.