com.cloudant.client.cache

Interface Cache<K,V>

All Known Subinterfaces:

CacheWithLifetimes<K,V>

All Known Implementing Classes:

LRUCache, RedisCache

public interface Cache<K,V>

Method Summary

Modifier and Type	Method and Description
void	clear() Delete all entries from the cache.
void	delete(K key) Delete a key-value pair from the cache.
void	deleteAll(java.util.List<K> keys) Delete one or more key-value pairs from the cache.
V	get(K key) Look up a value in the cache.
java.util.Map<K,V>	getAll(java.util.List<K> keys) Look up one or more values in the cache.
Stats	getStatistics() Get cache statistics.
void	put(K key, V value) Cache a key-value pair.
void	putAll(java.util.Map<K,V> map) Cache one or more key-value pairs.
long	size()

Method Detail

clear

void clear()

Delete all entries from the cache.

delete

void delete(K key)

Delete a key-value pair from the cache.

Parameters:

key - key corresponding to value

deleteAll

void deleteAll(java.util.List<K> keys)

Delete one or more key-value pairs from the cache.

Parameters:

keys - List containing the keys to delete

get

V get(K key)

Look up a value in the cache.

Parameters:

key - key corresponding to value

Returns:

value corresponding to key, null if key is not in cache or if value is expired

getAll

java.util.Map<K,V> getAll(java.util.List<K> keys)

Look up one or more values in the cache. Don't return expired values.

Parameters:

keys - List containing the keys to look up

Returns:

map containing key-value pairs corresponding to unexpired data in the cache

getStatistics

Stats getStatistics()

Get cache statistics.

Returns:

data structure containing statistics

put

void put(K key,
         V value)

Cache a key-value pair.

Parameters:

key - key associated with value

value - value associated with key

putAll

void putAll(java.util.Map<K,V> map)

Cache one or more key-value pairs.

Parameters:

map - map containing key-value pairs to cache

size

long size()

Returns:

the number of objects in cache