com.jivesoftware.util
Class CacheWrapper

java.lang.Object
  com.jivesoftware.util.CacheWrapper

All Implemented Interfaces:

Cache, java.util.Map

public class CacheWrapper
extends java.lang.Object
implements Cache

Acts as a proxy for a Cache implementation. The Cache implementation can be switched on the fly, which enables users to hold a reference to a CacheWrapper object, but for the underlying Cache implementation to switch from clustered to local, etc.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

CacheWrapper(Cache cache)

Method Summary

void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set	entrySet()
java.lang.Object	get(java.lang.Object key)
long	getCacheHits() Returns the number of cache hits.
long	getCacheMisses() Returns the number of cache misses.
int	getCacheSize() Returns the size of the cache contents in bytes.
int	getMaxCacheSize() Returns the maximum size of the cache in bytes.
long	getMaxLifetime() Returns the maximum number of milliseconds that any object can live in cache.
java.lang.String	getName() Returns the name of the cache.
Cache	getWrappedCache()
boolean	isEmpty()
java.util.Set	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map t)
java.lang.Object	remove(java.lang.Object key)
void	setMaxCacheSize(int maxSize) Sets the maximum size of the cache in bytes.
void	setMaxLifetime(long maxLifetime) Sets the maximum number of milliseconds that any object can live in cache.
void	setName(java.lang.String name) Sets the name of the cache
void	setWrappedCache(Cache cache)
int	size()
java.util.Collection	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

CacheWrapper

public CacheWrapper(Cache cache)

Method Detail

getWrappedCache

public Cache getWrappedCache()

setWrappedCache

public void setWrappedCache(Cache cache)

getName

public java.lang.String getName()

Description copied from interface: Cache

Returns the name of the cache.

Specified by:

getName in interface Cache

Returns:

the name of the cache.

setName

public void setName(java.lang.String name)

Description copied from interface: Cache

Sets the name of the cache

Specified by:

setName in interface Cache

Parameters:

name - the name of the cache

getMaxCacheSize

public int getMaxCacheSize()

Description copied from interface: Cache

Returns the maximum size of the cache in bytes. If the cache grows larger than the max size, the least frequently used items will be removed. If the max cache size is set to -1, there is no size limit.

Specified by:

getMaxCacheSize in interface Cache

Returns:

the maximum size of the cache in bytes.

setMaxCacheSize

public void setMaxCacheSize(int maxSize)

Description copied from interface: Cache

Sets the maximum size of the cache in bytes. If the cache grows larger than the max size, the least frequently used items will be removed. If the max cache size is set to -1, there is no size limit.

Specified by:

setMaxCacheSize in interface Cache

Parameters:

maxSize - the maximum size of the cache in bytes.

getMaxLifetime

public long getMaxLifetime()

Description copied from interface: Cache

Returns the maximum number of milliseconds that any object can live in cache. Once the specified number of milliseconds passes, the object will be automatically expried from cache. If the max lifetime is set to -1, then objects never expire.

Specified by:

getMaxLifetime in interface Cache

Returns:

the maximum number of milliseconds before objects are expired.

setMaxLifetime

public void setMaxLifetime(long maxLifetime)

Description copied from interface: Cache

Sets the maximum number of milliseconds that any object can live in cache. Once the specified number of milliseconds passes, the object will be automatically expried from cache. If the max lifetime is set to -1, then objects never expire.

Specified by:

setMaxLifetime in interface Cache

Parameters:

maxLifetime - the maximum number of milliseconds before objects are expired.

getCacheSize

public int getCacheSize()

Description copied from interface: Cache

Returns the size of the cache contents in bytes. This value is only a rough approximation, so cache users should expect that actual VM memory used by the cache could be significantly higher than the value reported by this method.

Specified by:

getCacheSize in interface Cache

Returns:

the size of the cache contents in bytes.

getCacheHits

public long getCacheHits()

Description copied from interface: Cache

Returns the number of cache hits. A cache hit occurs every time the get method is called and the cache contains the requested object.

Keeping track of cache hits and misses lets one measure how efficient the cache is; the higher the percentage of hits, the more efficient.

Specified by:

getCacheHits in interface Cache

Returns:

the number of cache hits.

getCacheMisses

public long getCacheMisses()

Description copied from interface: Cache

Returns the number of cache misses. A cache miss occurs every time the get method is called and the cache does not contain the requested object.

Keeping track of cache hits and misses lets one measure how efficient the cache is; the higher the percentage of hits, the more efficient.

Specified by:

getCacheMisses in interface Cache

Returns:

the number of cache hits.

size

public int size()

Specified by:

size in interface java.util.Map

clear

public void clear()

Specified by:

clear in interface java.util.Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

putAll

public void putAll(java.util.Map t)

Specified by:

putAll in interface java.util.Map

entrySet

public java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map