CacheWrapper (Core XMPP Server 4.4.0-beta API)

java.lang.Object
- org.jivesoftware.util.cache.CacheWrapper<K,V>

All Implemented Interfaces:

Map<K,V>, Cache<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.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<K,V>>`	`entrySet()` IMPORTANT: Unlike the standard `Map.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.
`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 standard `Map.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.
`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 cache
`int`	`size()`
`Collection<V>`	`values()` IMPORTANT: Unlike the standard `Map.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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Method Detail
  - getWrappedCache
```
public Cache<K,V> getWrappedCache()
```
  - getName
```
public String getName()
```
    Description copied from interface: Cache
    
    Returns the name of the cache.
    
    Specified by:
    
    getName in interface Cache<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 interface Cache<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 interface Cache<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. 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 interface Cache<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 interface Cache<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 interface Cache<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. 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<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 interface Cache<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 interface Cache<K extends Serializable,V extends Serializable>
    
    Returns:
    
    the number of cache hits.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K extends Serializable,V extends Serializable>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K extends Serializable,V extends Serializable>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K extends Serializable,V extends Serializable>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K extends Serializable,V extends Serializable>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K extends Serializable,V extends Serializable>
  - values
```
public Collection<V> values()
```
    Description copied from interface: Cache
    
    IMPORTANT: Unlike the standard Map.values() implementation, the collection returned from this method cannot be modified.
    
    Specified by:
    
    values in interface Map<K extends Serializable,V extends Serializable>
    
    Specified by:
    
    values in interface Cache<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 interface Map<K extends Serializable,V extends Serializable>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Description copied from interface: Cache
    
    IMPORTANT: Unlike the standard Map.entrySet() implementation, the set returned from this method cannot be modified.
    
    Specified by:
    
    entrySet in interface Map<K extends Serializable,V extends Serializable>
    
    Specified by:
    
    entrySet in interface Cache<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 standard Map.keySet() implementation, the set returned from this method cannot be modified.
    
    Specified by:
    
    keySet in interface Map<K extends Serializable,V extends Serializable>
    
    Specified by:
    
    keySet in interface Cache<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 interface Map<K extends Serializable,V extends Serializable>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K extends Serializable,V extends Serializable>
  - put
```
public V put(K key,
             V value)
```
    Specified by:
    
    put in interface Map<K extends Serializable,V extends Serializable>

Class CacheWrapper<K extends Serializable,V extends Serializable>

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jivesoftware.util.cache.Cache

Methods inherited from interface java.util.Map

Method Detail

getWrappedCache

getName

setName

getMaxCacheSize

setMaxCacheSize

getMaxLifetime

setMaxLifetime

getCacheSize

getCacheHits

getCacheMisses

size

clear

isEmpty

containsKey

containsValue

values

putAll

entrySet

keySet

get

remove

put