com.atlassian.confluence.cache

Class ThreadLocalCache

java.lang.Object

com.atlassian.confluence.cache.ThreadLocalCache

public class ThreadLocalCache
extends Object

A generic cache for "stuff" that is only needed for the lifetime of a web request or scheduled job. The most important rule for this cache is use custom types for keys. If you use some generic key type like a String, you will inevitably clobber someone else's cached data.

Don't use the ThreadLocalCache directly: use the ThreadLocalCacheAccessor to give you a typesafe container around the cache.

See Also:

ThreadLocalCacheAccessor

Constructor Summary

Constructors

Constructor and Description
ThreadLocalCache()

Method Summary

Modifier and Type	Method and Description
static void	dispose() Clean up the cache for the current thread.
static void	flush() Flush the contents of the cache, but do not clean up the cache itself.
static Object	get(Object key) Retrieve an object from the cache
static void	init() Initialise the cache for the current thread
static void	put(Object key, Object value) Put an object in the cache

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalCache

public ThreadLocalCache()

Method Detail

put

public static void put(Object key,
                       Object value)

Put an object in the cache

Parameters:

key - the cache key

value - the value to cache

get

public static Object get(Object key)

Retrieve an object from the cache

Parameters:

key - the cache key

Returns:

the appropriate cached value, or null if no value could be found, or the cache is not initialised

init

public static void init()

Initialise the cache for the current thread

dispose

public static void dispose()

Clean up the cache for the current thread.

flush

public static void flush()

Flush the contents of the cache, but do not clean up the cache itself.