org.conqat.lib.commons.cache4j

Interface ICache<K,V,X extends java.lang.Exception>

Type Parameters:

K - the key type. This must have both Object.equals(Object) and Object.hashCode() correctly implemented.

V - the value type. It is generally recommended to use an immutable type here, but this is not required.

X - the type of exception thrown. If no exception will be throws, use NeverThrownRuntimeException.

All Known Implementing Classes:

BasicCache, SynchronizedCache, ThreadLocalCache

public interface ICache<K,V,X extends java.lang.Exception>

Basic interface for a cache, which is basically a IParameterizedFactory with additional hit/miss statistics.

Method Summary

Modifier and Type	Method and Description
void	clear(boolean allThreads) Clears the cache, i.e.
int	getHits() Returns the number of cache hits so far.
long	getMissCostMillis() Returns an estimation of the overhead caused by cache misses in milliseconds.
int	getMisses() Returns the number of cache misses so far.
java.lang.String	getName() Returns the name (used for reporting).
V	obtain(K key) Obtain the value for a key.

Method Detail

obtain

V obtain(K key)
  throws X extends java.lang.Exception

Obtain the value for a key. This returns the cached element is possible. Otherwise the value is calculated (and stored in the cache for later use).

Throws:

X extends java.lang.Exception

clear

void clear(boolean allThreads)

Clears the cache, i.e. removes all cached data.

Parameters:

allThreads - if this is true, data will be discarded for all threads, otherwise only data for the current thread will be cleaned (if possible).

getName

java.lang.String getName()

Returns the name (used for reporting).

getHits

int getHits()

Returns the number of cache hits so far.

getMisses

int getMisses()

Returns the number of cache misses so far.

getMissCostMillis

long getMissCostMillis()

Returns an estimation of the overhead caused by cache misses in milliseconds.