AbstractCacheMap (jexx-core 1.0.13-RELEASE API)

java.lang.Object
- jexx.cache.AbstractCacheMap<K,V>

所有已实现的接口:

Cache<K,V>

直接已知子类:

TimedCache
```
public abstract class AbstractCacheMap<K,V>
extends java.lang.Object
implements Cache<K,V>
```
Default implementation of timed and size cache map. Implementations should:
- create a new cache map
- implements own prune strategy
Uses ReentrantReadWriteLock to synchronize access. Since upgrading from a read lock to the write lock is not possible, be careful withing get(Object) method.

字段概要

字段
限定符和类型	字段和说明
`protected java.util.Map<K,jexx.cache.AbstractCacheMap.CacheObject<K,V>>`	`cacheMap`
`protected int`	`cacheSize`
`protected boolean`	`existCustomTimeout` Identifies if objects has custom timeouts.
`protected int`	`hitCount`
`protected int`	`missCount`
`protected long`	`timeout`

构造器概要

构造器
构造器和说明

AbstractCacheMap()

构造器
构造器和说明
`AbstractCacheMap()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`clear()` Clears current cache.
`V`	`get(K key)` Retrieves an object from the cache.
`int`	`getHitCount()` Returns hit count.
`int`	`getMissCount()` Returns miss count.
`boolean`	`isEmpty()` Returns `true` if cache is empty.
`boolean`	`isFull()` Returns `true` if max cache capacity has been reached only if cache is size limited.
`protected boolean`	`isPruneExpiredActive()` Returns `true` if prune of expired objects should be invoked.
`protected boolean`	`isReallyFull(K key)`
`int`	`limit()` Returns cache size or `0` if there is no size limit.
`protected void`	`onRemove(K key, V cachedObject)` Callback called on item removal.
`int`	`prune()` Prunes objects from cache and returns the number of removed objects.
`protected abstract int`	`pruneCache()` Prune implementation.
`void`	`put(K key, V object)` Adds an object to the cache with default timeout.
`void`	`put(K key, V object, long timeout)` Adds an object to the cache with specified timeout after which it becomes expired.
`V`	`remove(K key)` Removes an object from the cache and returns removed value of `null` if object was not in the cache or was expired.
`int`	`size()` Returns current cache size.
`java.util.Map<K,V>`	`snapshot()` Creates a snapshot from current cache values.
`long`	`timeout()` Returns default cache timeout or `0` if it is not set.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - cacheMap
```
protected java.util.Map<K,jexx.cache.AbstractCacheMap.CacheObject<K,V>> cacheMap
```
  - cacheSize
```
protected int cacheSize
```
  - timeout
```
protected long timeout
```
  - existCustomTimeout
```
protected boolean existCustomTimeout
```
    Identifies if objects has custom timeouts. Should be used to determine if prune for existing objects is needed.
  - hitCount
```
protected int hitCount
```
  - missCount
```
protected int missCount
```
- 构造器详细资料
  - AbstractCacheMap
```
public AbstractCacheMap()
```
- 方法详细资料
  - limit
```
public int limit()
```
    Returns cache size or 0 if there is no size limit.
    
    指定者:
    
    limit 在接口中 Cache<K,V>
  - timeout
```
public long timeout()
```
    Returns default cache timeout or 0 if it is not set. Timeout can be set individually for each object.
    
    指定者:
    
    timeout 在接口中 Cache<K,V>
  - isPruneExpiredActive
```
protected boolean isPruneExpiredActive()
```
    Returns true if prune of expired objects should be invoked. For internal use.
  - put
```
public void put(K key,
                V object)
```
    Adds an object to the cache with default timeout.
    
    指定者:
    
    put 在接口中 Cache<K,V>
    
    另请参阅:
    
    Cache.put(Object, Object, long)
  - put
```
public void put(K key,
                V object,
                long timeout)
```
    Adds an object to the cache with specified timeout after which it becomes expired. If cache is full, Cache.prune() is invoked to make room for new object. Cached value must be non-null.
    
    指定者:
    
    put 在接口中 Cache<K,V>
  - getHitCount
```
public int getHitCount()
```
    Returns hit count.
  - getMissCount
```
public int getMissCount()
```
    Returns miss count.
  - get
```
public V get(K key)
```
    Retrieves an object from the cache. Returns null if object is not longer in cache or if it is expired.
    
    指定者:
    
    get 在接口中 Cache<K,V>
  - pruneCache
```
protected abstract int pruneCache()
```
    Prune implementation.
  - prune
```
public final int prune()
```
    Prunes objects from cache and returns the number of removed objects. Used strategy depends on cache implementation.
    
    指定者:
    
    prune 在接口中 Cache<K,V>
  - isFull
```
public boolean isFull()
```
    Returns true if max cache capacity has been reached only if cache is size limited.
    
    指定者:
    
    isFull 在接口中 Cache<K,V>
  - isReallyFull
```
protected boolean isReallyFull(K key)
```
  - remove
```
public V remove(K key)
```
    Removes an object from the cache and returns removed value of null if object was not in the cache or was expired.
    
    指定者:
    
    remove 在接口中 Cache<K,V>
  - clear
```
public void clear()
```
    Clears current cache.
    
    指定者:
    
    clear 在接口中 Cache<K,V>
  - size
```
public int size()
```
    Returns current cache size.
    
    指定者:
    
    size 在接口中 Cache<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if cache is empty.
    
    指定者:
    
    isEmpty 在接口中 Cache<K,V>
  - snapshot
```
public java.util.Map<K,V> snapshot()
```
    Creates a snapshot from current cache values. Returned values may not longer be valid or they might be already expired! Cache is locked during the snapshot creation.
    
    指定者:
    
    snapshot 在接口中 Cache<K,V>
  - onRemove
```
protected void onRemove(K key,
                        V cachedObject)
```
    Callback called on item removal. The cache is still locked.

类 AbstractCacheMap<K,V>

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

cacheMap

cacheSize

timeout

existCustomTimeout

hitCount

missCount

构造器详细资料

AbstractCacheMap

方法详细资料

limit

timeout

isPruneExpiredActive

put

put

getHitCount

getMissCount

get

pruneCache

prune

isFull

isReallyFull

remove

clear

size

isEmpty

snapshot

onRemove