| java.lang.Object org.jamwiki.utils.WikiCache
WikiCache | public class WikiCache (Code) | | Implement utility functions that interact with the cache and provide the
infrastructure for storing and retrieving items from the cache.
|
Method Summary | |
public static void | addToCache(String cacheName, Object key, Object value) Add an object to the cache. | public static void | addToCache(String cacheName, int key, Object value) Add an object to the cache. | public static void | initialize() Initialize the cache, clearing any existing cache instances and loading
a new cache instance. | public static String | key(String virtualWiki, String topicName) Given a virtual wiki name and a topic name, generate a unique key value
that can be used to store and retrieve cache objects.
Parameters: virtualWiki - The virtual wiki name for the key value beingcreated. Parameters: topicName - The name of the topic for the key value being created. | public static void | removeCache(String cacheName) Remove a cache with the given name from the system, freeing any
resources used by that cache. | public static void | removeFromCache(String cacheName, Object key) Remove a value from the cache with the given key and name. | public static void | removeFromCache(String cacheName, int key) Remove a value from the cache with the given key and name. | public static Element | retrieveFromCache(String cacheName, Object key) Retrieve a cached element from the cache. | public static Element | retrieveFromCache(String cacheName, int key) Retrieve a cached element from the cache. | public static void | shutdown() |
addToCache | public static void addToCache(String cacheName, Object key, Object value)(Code) | | Add an object to the cache.
Parameters: cacheName - The name of the cache that the object is being addedto. Parameters: key - A String, Integer, or other object to use as the key forstoring and retrieving this object from the cache. Parameters: value - The object that is being stored in the cache. |
addToCache | public static void addToCache(String cacheName, int key, Object value)(Code) | | Add an object to the cache.
Parameters: cacheName - The name of the cache that the object is being addedto. Parameters: key - An int value to use as the key for storing and retrievingthis object from the cache. Parameters: value - The object that is being stored in the cache. |
initialize | public static void initialize()(Code) | | Initialize the cache, clearing any existing cache instances and loading
a new cache instance.
|
key | public static String key(String virtualWiki, String topicName)(Code) | | Given a virtual wiki name and a topic name, generate a unique key value
that can be used to store and retrieve cache objects.
Parameters: virtualWiki - The virtual wiki name for the key value beingcreated. Parameters: topicName - The name of the topic for the key value being created. The generated key value. |
removeCache | public static void removeCache(String cacheName)(Code) | | Remove a cache with the given name from the system, freeing any
resources used by that cache.
Parameters: cacheName - The name of the cache being removed. |
removeFromCache | public static void removeFromCache(String cacheName, Object key)(Code) | | Remove a value from the cache with the given key and name.
Parameters: cacheName - The name of the cache from which the object is beingremoved. Parameters: key - The key for the record that is being removed from the cache. |
removeFromCache | public static void removeFromCache(String cacheName, int key)(Code) | | Remove a value from the cache with the given key and name.
Parameters: cacheName - The name of the cache from which the object is beingremoved. Parameters: key - The key for the record that is being removed from the cache. |
retrieveFromCache | public static Element retrieveFromCache(String cacheName, Object key)(Code) | | Retrieve a cached element from the cache. This method will return
null if no matching element is cached, an element with
no value if a null value is cached, or an element with a
valid object value if such an element is cached.
Parameters: cacheName - The name of the cache from which the object is beingretrieved. Parameters: key - The key for the record that is being retrieved from thecache. A new Element object containing the key and cachedobject value. |
retrieveFromCache | public static Element retrieveFromCache(String cacheName, int key)(Code) | | Retrieve a cached element from the cache. This method will return
null if no matching element is cached, an element with
no value if a null value is cached, or an element with a
valid object value if such an element is cached.
Parameters: cacheName - The name of the cache from which the object is beingretrieved. Parameters: key - The key for the record that is being retrieved from thecache. A new Element object containing the key and cachedobject value. |
shutdown | public static void shutdown()(Code) | | |
|
|