com.yahoo.bard.webservice.data.cache

Interface DataCache<T extends Serializable>

Type Parameters:

T - The value type being stored

All Known Subinterfaces:

TupleDataCache<K,M,V>

All Known Implementing Classes:

HashDataCache, MemDataCache, MemTupleDataCache, StubDataCache

public interface DataCache<T extends Serializable>

A very thin wrapper around key value storage.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this cache.
T	get(String key) Read data from cache.
boolean	set(String key, T value) Put a value on a key in a data cache.

Method Detail

get

T get(String key)

Read data from cache.

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

set

boolean set(String key,
            T value)
     throws IllegalStateException

Put a value on a key in a data cache.

Parameters:

key - the key under which this object should be added.

value - the object to store

Returns:

a boolean representing success of this operation

Throws:

IllegalStateException - in the rare circumstance where queue is too full to accept any more requests

clear

void clear()

Removes all of the mappings from this cache.