ides.api.cache
Interface Cache


public interface Cache

Interface for classes that provide access to a disk-based cache. The main is intended to be the caching of rendered LaTeX labels so that they don't have to be re-rendered all the time.

Author:
Lenko Grigorov

Method Summary
 java.lang.Object get(java.lang.String key)
          Retrieve an object from the cache.
 void put(java.lang.String key, java.lang.Object value)
          Put a Serializable object into the cache.
 

Method Detail

put

void put(java.lang.String key,
         java.lang.Object value)
Put a Serializable object into the cache.

Parameters:
key - the key that will be used for retrieval
value - the object to be stored in the cache
See Also:
get(String)

get

java.lang.Object get(java.lang.String key)
                     throws NotInCacheException
Retrieve an object from the cache.

Parameters:
key - the key used to retrieve the object
Returns:
the object retrieved
Throws:
NotInCacheException - when the object is not found in the cache
See Also:
put(String, Object)