org.springframework.data.redis.core

Interface BoundHashOperations<H,HK,HV>

All Superinterfaces:

BoundKeyOperations<H>

public interface BoundHashOperations<H,HK,HV>
extends BoundKeyOperations<H>

Hash operations bound to a certain key.

Author:

Costin Leau, Christoph Strobl, Ninad Divadkar, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Long	delete(Object... keys) Delete given hash keys at the bound key.
Map<HK,HV>	entries() Get entire hash at the bound key.
HV	get(Object member) Get value for given key from the hash at the bound key.
RedisOperations<H,?>	getOperations()
Boolean	hasKey(Object key) Determine if given hash key exists at the bound key.
Double	increment(HK key, double delta) Increment value of a hash key by the given delta at the bound key.
Long	increment(HK key, long delta) Increment value of a hash key by the given delta at the bound key.
Set<HK>	keys() Get key set (fields) of hash at the bound key.
Long	lengthOfValue(HK hashKey) Returns the length of the value associated with hashKey.
List<HV>	multiGet(Collection<HK> keys) Get values for given keys from the hash at the bound key.
void	put(HK key, HV value) Set the value of a hash key at the bound key.
void	putAll(Map<? extends HK,? extends HV> m) Set multiple hash fields to multiple values using data provided in m at the bound key.
Boolean	putIfAbsent(HK key, HV value) Set the value of a hash key only if key does not exist.
Cursor<Map.Entry<HK,HV>>	scan(ScanOptions options) Use a Cursor to iterate over entries in the hash.
Long	size() Get size of hash at the bound key.
List<HV>	values() Get entry set (values) of hash at the bound key.

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

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

Method Detail

delete

@Nullable
Long delete(Object... keys)

Delete given hash keys at the bound key.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

hasKey

@Nullable
Boolean hasKey(Object key)

Determine if given hash key exists at the bound key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

get

@Nullable
HV get(Object member)

Get value for given key from the hash at the bound key.

Parameters:

member - must not be null.

Returns:

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

multiGet

@Nullable
List<HV> multiGet(Collection<HK> keys)

Get values for given keys from the hash at the bound key.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

increment

@Nullable
Long increment(HK key,
                         long delta)

Increment value of a hash key by the given delta at the bound key.

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

increment

@Nullable
Double increment(HK key,
                           double delta)

Increment value of a hash key by the given delta at the bound key.

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

keys

@Nullable
Set<HK> keys()

Get key set (fields) of hash at the bound key.

Returns:

null when used in pipeline / transaction.

lengthOfValue

@Nullable
Long lengthOfValue(HK hashKey)

Returns the length of the value associated with hashKey. If the hashKey do not exist, 0 is returned.

Parameters:

hashKey - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

size

@Nullable
Long size()

Get size of hash at the bound key.

Returns:

null when used in pipeline / transaction.

putAll

void putAll(Map<? extends HK,? extends HV> m)

Set multiple hash fields to multiple values using data provided in m at the bound key.

Parameters:

m - must not be null.

put

void put(HK key,
         HV value)

Set the value of a hash key at the bound key.

Parameters:

key - must not be null.

value -

putIfAbsent

@Nullable
Boolean putIfAbsent(HK key,
                              HV value)

Set the value of a hash key only if key does not exist.

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

values

@Nullable
List<HV> values()

Get entry set (values) of hash at the bound key.

Returns:

null when used in pipeline / transaction.

entries

@Nullable
Map<HK,HV> entries()

Get entire hash at the bound key.

Returns:

null when used in pipeline / transaction.

scan

Cursor<Map.Entry<HK,HV>> scan(ScanOptions options)

Use a Cursor to iterate over entries in the hash.

Parameters:

options -

Returns:

Since:

1.4

getOperations

RedisOperations<H,?> getOperations()

Returns:

never null.