edu.cmu.sphinx.util

Class Cache<T>

java.lang.Object

edu.cmu.sphinx.util.Cache<T>

public class Cache<T>
extends java.lang.Object

Provides a simple object cache.

Object stored in cache must properly implement hashCode and equals.

Note that this class is not synchronized. If multiple threads access a cache concurrently, and at least one of the threads modifies the cache, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the cache.

Constructor Summary

Constructors

Constructor and Description
Cache()

Method Summary

Modifier and Type	Method and Description
T	cache(T object) Puts the given object in the cache if it is not already present.
int	getHits() Returns the number of cache hits, which is the number of times cache(T) was called and returned an object that already existed in the cache.
int	getMisses() Returns the number of cache misses, which is the number of times cache(T) was called and returned null (after caching the object), effectively representing the size of the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cache

public Cache()

Method Detail

cache

public T cache(T object)

Puts the given object in the cache if it is not already present.

If the object is already cached, than the instance that exists in the cached is returned. Otherwise, it is placed in the cache and null is returned.

Parameters:

object - object to cache

Returns:

the cached object or null if the given object was not already cached

getHits

public int getHits()

Returns the number of cache hits, which is the number of times cache(T) was called and returned an object that already existed in the cache.

Returns:

the number of cache hits

getMisses

public int getMisses()

Returns the number of cache misses, which is the number of times cache(T) was called and returned null (after caching the object), effectively representing the size of the cache.

Returns:

the number of cache misses