org.rarefiedredis.redis

Interface IRedisCache<T,U>

Type Parameters:

T - The type of values this cache stores.

U - The type of values this cache returns.

All Known Implementing Classes:

RedisHashCache, RedisListCache, RedisSetCache, RedisSortedSetCache, RedisStringCache

public interface IRedisCache<T,U>

Interface for all key-value caches. An IRedisCache caches (key, value, ...) tuples.

Method Summary

Modifier and Type	Method and Description
Boolean	exists(String key) Does the key exist in the cache?
U	get(String key) Get the key from the cache.
void	remove(String key) Remove the key from the cache.
Boolean	removeValue(String key, T value) Remove the value from the cache.
void	set(String key, T value, Object... arguments) Set the (key, value, ...) tuple in the cache.
String	type() Return the type identifier of this cache.

Method Detail

exists

Boolean exists(String key)

Does the key exist in the cache?

Parameters:

key - The key to check.

Returns:

true if the key exists in the cache, or false.

remove

void remove(String key)

Remove the key from the cache.

Parameters:

key - The key to remove.

set

void set(String key,
         T value,
         Object... arguments)

Set the (key, value, ...) tuple in the cache.

Parameters:

key - The key to store.

value - The value to store.

arguments - Varargs with the rest of the tuple particular for this cache.

get

U get(String key)

Get the key from the cache. Should return null or equivalent for the Type if the key is not in the cache.

Parameters:

key - The key to get

Returns:

The value stored at key.

removeValue

Boolean removeValue(String key,
                    T value)

Remove the value from the cache. Should return false if either the key or the value is not in the cache.

Parameters:

key - The key to remove from.

value - The value to remove in key.

Returns:

true if the value was removed, or false.

type

String type()

Return the type identifier of this cache.

Returns:

Type identifier for this cache.