Interface BoundValueOperations<K,V>

All Superinterfaces:

BoundKeyOperations<K>

@NullUnmarked
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, Marcin Grzejszczak, Yordan Tsintsov

Method Summary

Modifier and Type	Method	Description
Integer	append(@NonNull String value)	Append a value to the bound key.
Boolean	compareAndSet(@NonNull V expectedValue, @NonNull V newValue)	Compare the value at the bound key with expectedValue and set it to newValue if they are equal.
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, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of getAndExpire(Expiration).
V	getAndExpire(@NonNull Duration timeout)	Return the value at the bound key and expire the key by applying timeout.
V	getAndExpire(@NonNull Expiration expiration)	Return the value at the bound key and expire the key by applying expiration.
V	getAndPersist()	Return the value at the bound key and persist the key.
V	getAndSet(@NonNull V value)	Set value of the bound key and return its old value.
@NonNull 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(@NonNull V value)	Set value for the bound key.
void	set(@NonNull V value, long offset)	Overwrite parts of the bound key starting at the specified offset with given value.
void	set(@NonNull V value, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of set(Object, Expiration).
void	set(@NonNull V value, @NonNull Duration timeout)	Set the value and expiration timeout for the bound key.
Boolean	set(@NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)	Set value for the bound key and customize the operation through SetSpec.
void	set(@NonNull V value, @NonNull Expiration expiration)	Set value and expiration for the bound key.
V	setGet(@NonNull V value, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of setGet(Object, Consumer).
V	setGet(@NonNull V value, @NonNull Duration timeout)	Set the value and expiration timeout for the bound key.
V	setGet(@NonNull V value, @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)	Set value for the bound key and customize the operation through SetSpec.
V	setGet(@NonNull V value, @NonNull Expiration expiration)	Set the value and expiration for the bound key.
Boolean	setIfAbsent(@NonNull V value)	Set the bound key to hold the string value if the bound key is absent.
Boolean	setIfAbsent(@NonNull V value, long timeout, @NonNull TimeUnit unit)	Deprecated. since 4.1 in favor of setIfAbsent(Object, Expiration).
Boolean	setIfAbsent(@NonNull V value, @NonNull Duration timeout)	Set bound key to hold the string value and expiration timeout if the bound key is absent.
Boolean	setIfAbsent(@NonNull V value, @NonNull Expiration expiration)	Set the bound key to hold the string value and expiration if the bound key is absent.
Boolean	setIfPresent(@NonNull V value)	Set the bound key to hold the string value if the bound key is present.
Boolean	setIfPresent(@NonNull V value, long timeout, @NonNull TimeUnit unit)	Deprecated.
Boolean	setIfPresent(@NonNull V value, @NonNull Duration timeout)	Set the bound key to hold the string value and expiration timeout if the bound key is present.
Boolean	setIfPresent(@NonNull V value, @NonNull Expiration expiration)	Set the bound key to hold the string value and expiration if the bound key is present.
Long	size()	Get the length of the value stored at the bound key.

Methods inherited from interface BoundKeyOperations

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

Method Details

set

void set(@NonNull V value)

Set value for the bound key.

Parameters:

value - must not be null.

See Also:

• Redis Documentation: SET

set

void set(@NonNull V value,
 @NonNull Expiration expiration)

Set value and expiration for the bound key.

Parameters:

value - must not be null.

expiration - must not be null.

Since:

4.1

See Also:

• Redis Documentation: SET

set

@Deprecated(since="4.1")
void set(@NonNull V value,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of set(Object, Expiration).

Set the value and expiration timeout for the bound key.

Parameters:

value - must not be null.

timeout - must not be null.

unit - must not be null.

See Also:

• Redis Documentation: SET

set

void set(@NonNull V value,
 @NonNull 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:

• Redis Documentation: SET

set

Boolean set(@NonNull V value,
 @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)

Set value for the bound key and customize the operation through SetSpec.

Parameters:

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:

• Redis Documentation: SET

setGet

V setGet(@NonNull V value,
 @NonNull Expiration expiration)

Set the value and expiration for the bound 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:

value - must not be null.

expiration - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

4.1

See Also:

• Redis Documentation: SET

setGet

V setGet(@NonNull V value,
 @NonNull Consumer<SetSpec<@NonNull K, @NonNull V>> setConsumer)

Set value for the bound key and customize the operation through SetSpec. Return the old string stored at key, or null if key did not exist.

Parameters:

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:

• Redis Documentation: SET

setGet

@Deprecated(since="4.1")
V setGet(@NonNull V value,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of setGet(Object, Consumer).

Set the value and expiration timeout for the bound 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:

value - must not be null.

timeout - must not be null.

unit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: SET

setGet

V setGet(@NonNull V value,
 @NonNull Duration timeout)

Set the value and expiration timeout for the bound 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:

value - must not be null.

timeout - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: SET

setIfAbsent

Boolean setIfAbsent(@NonNull 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:

• Redis Documentation: SETNX

setIfAbsent

Boolean setIfAbsent(@NonNull V value,
 @NonNull Expiration expiration)

Set the bound key to hold the string value and expiration if the bound key is absent.

Parameters:

value - must not be null.

expiration - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

4.1

See Also:

• Redis Documentation: SET

setIfAbsent

@Deprecated(since="4.1")
Boolean setIfAbsent(@NonNull V value,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of setIfAbsent(Object, Expiration).

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 - must not be null.

unit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

• Redis Documentation: SET

setIfAbsent

Boolean setIfAbsent(@NonNull V value,
 @NonNull 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:

• Redis Documentation: SET

setIfPresent

Boolean setIfPresent(@NonNull 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:

• Redis Documentation: SET

setIfPresent

Boolean setIfPresent(@NonNull V value,
 @NonNull Expiration expiration)

Set the bound key to hold the string value and expiration if the bound key is present.

Parameters:

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:

• Redis Documentation: SET

setIfPresent

@Deprecated(since="4.1")
Boolean setIfPresent(@NonNull V value,
 long timeout,
 @NonNull TimeUnit unit)

Deprecated.

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.

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:

• Redis Documentation: SET

setIfPresent

Boolean setIfPresent(@NonNull V value,
 @NonNull 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:

• Redis Documentation: SET

compareAndSet

Boolean compareAndSet(@NonNull V expectedValue,
 @NonNull V newValue)

Compare the value at the bound key with expectedValue and set it to newValue if they are equal.

Parameters:

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:

• Redis Documentation: SET

get

V get()

Get the value of the bound key.

Returns:

null when key does not exist or used in pipeline / transaction.

See Also:

• Redis Documentation: GET

getAndDelete

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:

• Redis Documentation: GETDEL

getAndExpire

V getAndExpire(@NonNull Expiration expiration)

Return the value at the bound key and expire the key by applying expiration.

Parameters:

expiration - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

Since:

4.1

See Also:

• Redis Documentation: GETEX

getAndExpire

@Deprecated(since="4.1")
V getAndExpire(long timeout,
 @NonNull TimeUnit unit)

Deprecated.

since 4.1 in favor of getAndExpire(Expiration).

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:

• Redis Documentation: GETEX

getAndExpire

V getAndExpire(@NonNull 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:

• Redis Documentation: GETEX

getAndPersist

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:

• Redis Documentation: GETEX

getAndSet

V getAndSet(@NonNull V value)

Set value of the bound key and return its old value.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: GETSET

increment

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:

• Redis Documentation: INCR

increment

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:

• Redis Documentation: INCRBY

increment

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:

• Redis Documentation: INCRBYFLOAT

decrement

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:

• Redis Documentation: DECR

decrement

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:

• Redis Documentation: DECRBY

append

Integer append(@NonNull String value)

Append a value to the bound key.

Parameters:

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: APPEND

get

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:

• Redis Documentation: GETRANGE

set

void set(@NonNull 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:

• Redis Documentation: SETRANGE

size

Long size()

Get the length of the value stored at the bound key.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: STRLEN

getOperations

@NonNull RedisOperations<K,V> getOperations()

Specified by:

getOperations in interface BoundKeyOperations<K>

Returns:

the underlying RedisOperations used to execute commands.