Package org.jivesoftware.util.cache
Class CacheWrapper<K extends Serializable,V extends Serializable>
- java.lang.Object
-
- org.jivesoftware.util.cache.CacheWrapper<K,V>
-
- Direct Known Subclasses:
ComponentCacheWrapper
public class CacheWrapper<K extends Serializable,V extends Serializable> extends Object implements Cache<K,V>
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.
-
-
Field Summary
-
Fields inherited from interface org.jivesoftware.util.cache.Cache
secretKey, secretValue
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
boolean
containsKey(Object key)
boolean
containsValue(Object value)
Set<Map.Entry<K,V>>
entrySet()
IMPORTANT: Unlike the standardMap.entrySet()
implementation, the set returned from this method cannot be modified.V
get(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 limited to integer size.long
getLongCacheSize()
Returns the size of the cache contents in bytes.long
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.String
getName()
Returns the name of the cache.Cache<K,V>
getWrappedCache()
boolean
isEmpty()
Set<K>
keySet()
IMPORTANT: Unlike the standardMap.keySet()
implementation, the set returned from this method cannot be modified.V
put(K key, V value)
void
putAll(Map<? extends K,? extends V> t)
V
remove(Object key)
void
setMaxCacheSize(int maxSize)
Sets the maximum size of the cache in bytes limited to integer size.void
setMaxCacheSize(long 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(String name)
Sets the name of the cacheint
size()
Collection<V>
values()
IMPORTANT: Unlike the standardMap.values()
implementation, the collection returned from this method cannot be modified.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jivesoftware.util.cache.Cache
getLock, isKeySecret, isValueSecret, setSecretKey, setSecretValue
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:Cache
Returns the name of the cache.- Specified by:
getName
in interfaceCache<K extends Serializable,V extends Serializable>
- Returns:
- the name of the cache.
-
setName
public void setName(String name)
Description copied from interface:Cache
Sets the name of the cache- Specified by:
setName
in interfaceCache<K extends Serializable,V extends Serializable>
- Parameters:
name
- the name of the cache
-
getMaxCacheSize
public long 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 interfaceCache<K extends Serializable,V extends Serializable>
- 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 limited to integer size. 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.Note: If using the Hazelcast clustering plugin, this will not take effect until the next time the cache is created
- Specified by:
setMaxCacheSize
in interfaceCache<K extends Serializable,V extends Serializable>
- Parameters:
maxSize
- the maximum size of the cache in bytes.
-
setMaxCacheSize
public void setMaxCacheSize(long 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.Note: If using the Hazelcast clustering plugin, this will not take effect until the next time the cache is created
Attention: The default implementation of this method sets the cache value limited to integer size.- Specified by:
setMaxCacheSize
in interfaceCache<K extends Serializable,V extends Serializable>
- 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 expired from cache. If the max lifetime is set to -1, then objects never expire.- Specified by:
getMaxLifetime
in interfaceCache<K extends Serializable,V extends Serializable>
- 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 expired from cache. If the max lifetime is set to -1, then objects never expire.Note: If using the Hazelcast clustering plugin, this will not take effect until the next time the cache is created
- Specified by:
setMaxLifetime
in interfaceCache<K extends Serializable,V extends Serializable>
- 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 limited to integer size. 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 interfaceCache<K extends Serializable,V extends Serializable>
- Returns:
- the size of the cache contents in bytes.
-
getLongCacheSize
public long getLongCacheSize()
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. Attention: The default implementation of this method returns the cache value limited to integer size.- Specified by:
getLongCacheSize
in interfaceCache<K extends Serializable,V extends Serializable>
- 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 interfaceCache<K extends Serializable,V extends Serializable>
- 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 interfaceCache<K extends Serializable,V extends Serializable>
- Returns:
- the number of cache hits.
-
size
public int size()
- Specified by:
size
in interfaceMap<K extends Serializable,V extends Serializable>
-
clear
public void clear()
- Specified by:
clear
in interfaceMap<K extends Serializable,V extends Serializable>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceMap<K extends Serializable,V extends Serializable>
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<K extends Serializable,V extends Serializable>
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<K extends Serializable,V extends Serializable>
-
values
public Collection<V> values()
Description copied from interface:Cache
IMPORTANT: Unlike the standardMap.values()
implementation, the collection returned from this method cannot be modified.- Specified by:
values
in interfaceCache<K extends Serializable,V extends Serializable>
- Specified by:
values
in interfaceMap<K extends Serializable,V extends Serializable>
- Returns:
- an unmodifiable collection view of the values contained in this map
-
putAll
public void putAll(Map<? extends K,? extends V> t)
- Specified by:
putAll
in interfaceMap<K extends Serializable,V extends Serializable>
-
entrySet
public Set<Map.Entry<K,V>> entrySet()
Description copied from interface:Cache
IMPORTANT: Unlike the standardMap.entrySet()
implementation, the set returned from this method cannot be modified.- Specified by:
entrySet
in interfaceCache<K extends Serializable,V extends Serializable>
- Specified by:
entrySet
in interfaceMap<K extends Serializable,V extends Serializable>
- Returns:
- an unmodifiable set view of the mappings contained in this map
-
keySet
public Set<K> keySet()
Description copied from interface:Cache
IMPORTANT: Unlike the standardMap.keySet()
implementation, the set returned from this method cannot be modified.- Specified by:
keySet
in interfaceCache<K extends Serializable,V extends Serializable>
- Specified by:
keySet
in interfaceMap<K extends Serializable,V extends Serializable>
- Returns:
- an unmodifiable set view of the keys contained in this map
-
get
public V get(Object key)
- Specified by:
get
in interfaceMap<K extends Serializable,V extends Serializable>
-
remove
public V remove(Object key)
- Specified by:
remove
in interfaceMap<K extends Serializable,V extends Serializable>
-
put
public V put(K key, V value)
- Specified by:
put
in interfaceMap<K extends Serializable,V extends Serializable>
-
-