org.springframework.data.redis.core

Interface ValueOperations<K,V>

public interface ValueOperations<K,V>

Redis operations for simple (or in Redis terminology 'string') values.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, Jiahe Cai

Method Summary

Modifier and Type	Method and Description
Integer	append(K key, String value) Append a value to key.
List<Long>	bitField(K key, BitFieldSubCommands subCommands) Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
Long	decrement(K key) Decrement an integer value stored as string value under key by one.
Long	decrement(K key, long delta) Decrement an integer value stored as string value under key by delta.
String	get(K key, long start, long end) Get a substring of value of key between begin and end.
V	get(Object key) Get the value of key.
V	getAndSet(K key, V value) Set value of key and return its old value.
Boolean	getBit(K key, long offset) Get the bit value at offset of value at key.
RedisOperations<K,V>	getOperations()
Long	increment(K key) Increment an integer value stored as string value under key by one.
Double	increment(K key, double delta) Increment a floating point number value stored as string value under key by delta.
Long	increment(K key, long delta) Increment an integer value stored as string value under key by delta.
List<V>	multiGet(Collection<K> keys) Get multiple keys.
void	multiSet(Map<? extends K,? extends V> map) Set multiple keys to multiple values using key-value pairs provided in tuple.
Boolean	multiSetIfAbsent(Map<? extends K,? extends 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(K key, V value) Set value for key.
default void	set(K key, V value, Duration timeout) Set the value and expiration timeout for key.
void	set(K key, V value, long offset) Overwrite parts of key starting at the specified offset with given value.
void	set(K key, V value, long timeout, TimeUnit unit) Set the value and expiration timeout for key.
Boolean	setBit(K key, long offset, boolean value) Sets the bit at offset in value stored at key.
Boolean	setIfAbsent(K key, V value) Set key to hold the string value if key is absent.
default Boolean	setIfAbsent(K key, V value, Duration timeout) Set key to hold the string value and expiration timeout if key is absent.
Boolean	setIfAbsent(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is absent.
Boolean	setIfPresent(K key, V value) Set key to hold the string value if key is present.
default Boolean	setIfPresent(K key, V value, Duration timeout) Set key to hold the string value and expiration timeout if key is present.
Boolean	setIfPresent(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is present.
Long	size(K key) Get the length of the value stored at key.

Method Detail

set

void set(K key,
         V value)

Set value for key.

Parameters:

key - must not be null.

value - must not be null.

See Also:

Redis Documentation: SET

set

void set(K key,
         V value,
         long timeout,
         TimeUnit unit)

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:

Redis Documentation: SETEX

set

default void set(K key,
                 V value,
                 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:

Redis Documentation: SETEX

setIfAbsent

@Nullable
Boolean setIfAbsent(K key,
                              V value)

Set key to hold the string value if key is absent.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SETNX

setIfAbsent

@Nullable
Boolean setIfAbsent(K key,
                              V value,
                              long timeout,
                              TimeUnit unit)

Set key to hold the string value and expiration timeout 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:

Redis Documentation: SET

setIfAbsent

@Nullable
default Boolean setIfAbsent(K key,
                                      V value,
                                      Duration timeout)

Set key to hold the string value and expiration timeout 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:

Redis Documentation: SET

setIfPresent

@Nullable
Boolean setIfPresent(K key,
                               V value)

Set key to hold the string value 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:

Redis Documentation: SET

setIfPresent

@Nullable
Boolean setIfPresent(K key,
                               V value,
                               long timeout,
                               TimeUnit unit)

Set key to hold the string value and expiration timeout 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:

Redis Documentation: SET

setIfPresent

@Nullable
default Boolean setIfPresent(K key,
                                       V value,
                                       Duration timeout)

Set key to hold the string value and expiration timeout 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:

Redis Documentation: SET

multiSet

void multiSet(Map<? extends K,? extends V> map)

Set multiple keys to multiple values using key-value pairs provided in tuple.

Parameters:

map - must not be null.

See Also:

Redis Documentation: MSET

multiSetIfAbsent

@Nullable
Boolean multiSetIfAbsent(Map<? extends K,? extends 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:

Redis Documentation: MSETNX

get

@Nullable
V get(Object key)

Get the value of key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GET

getAndSet

@Nullable
V getAndSet(K key,
                      V value)

Set value of key and return its old value.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETSET

multiGet

@Nullable
List<V> multiGet(Collection<K> keys)

Get multiple keys. Values are returned in the order of the requested keys.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: MGET

increment

@Nullable
Long increment(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:

Redis Documentation: INCR

increment

@Nullable
Long increment(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:

Redis Documentation: INCRBY

increment

@Nullable
Double increment(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:

Redis Documentation: INCRBYFLOAT

decrement

@Nullable
Long decrement(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:

Redis Documentation: DECR

decrement

@Nullable
Long decrement(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:

Redis Documentation: DECRBY

append

@Nullable
Integer append(K key,
                         String value)

Append a value to key.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: APPEND

get

@Nullable
String get(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:

Redis Documentation: GETRANGE

set

void set(K key,
         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:

Redis Documentation: SETRANGE

size

@Nullable
Long size(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:

Redis Documentation: STRLEN

setBit

@Nullable
Boolean setBit(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:

Redis Documentation: SETBIT

getBit

@Nullable
Boolean getBit(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:

Redis Documentation: GETBIT

bitField

@Nullable
List<Long> bitField(K key,
                              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:

Redis Documentation: BITFIELD

getOperations

RedisOperations<K,V> getOperations()