SimpleCache (Trinea Android Common Library 4.2.15 API)

java.lang.Object
- cn.trinea.android.common.service.impl.SimpleCache<K,V>

所有已实现的接口:

Cache<K,V>, Serializable

直接已知子类:

PreloadDataCache
```
public class SimpleCache<K,V>
extends Object
implements Cache<K,V>, Serializable
```
Simple Cache
- Use one of constructors below to construct cache
- setCacheFullRemoveType(CacheFullRemoveType) set remove type when cache is full
- setValidTime(long) set valid time of elements in cache, in mills
- put(Object, CacheObject) or put(Object, Object) put element
- get(Object) get element
- loadCache(String) restore cache from file
- saveCache(String, SimpleCache) save cache to file
- SimpleCache()
- SimpleCache(int)
- loadCache(String) restore cache from file
- getHitRate() get hit rate of the cache
- getHitCount() get hit count of the cache
- getMissCount() get miss count of the cache
- getMaxSize() get the maximum capacity of the cache
- getSize() get the number of elements in the cache valid
作者:

Trinea 2011-12-23

另请参阅:
序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected Map<K,CacheObject<V>>`	`cache` map to storage element
`static int`	`DEFAULT_MAX_SIZE` default maximum capacity of the cache
`protected AtomicLong`	`hitCount` hit count of cache
`protected AtomicLong`	`missCount` miss count of cache

构造器概要

构造器
构造器和说明
`SimpleCache()` Maximum size of the cache is `DEFAULT_MAX_SIZE` Elements of the cache will not invalid, can set by `setValidTime(long)` Remove type is `RemoveTypeEnterTimeFirst` when cache is full
`SimpleCache(int maxSize)` Elements of the cache will not invalid, can set by `setValidTime(long)` Remove type is `RemoveTypeEnterTimeFirst` when cache is full

方法概要

方法
限定符和类型	方法和说明
`void`	`clear()` Removes all elements from this Map, leaving it empty.
`boolean`	`containsKey(K key)` whether this cache contains the specified key.
`Set<Map.Entry<K,CacheObject<V>>>`	`entrySet()` key value set
`protected CacheObject<V>`	`fullRemoveOne()` remove a element when cache is full. according to `getCacheFullRemoveType()` if `getCacheFullRemoveType()` is instance of `RemoveTypeNotRemove` return null, else remove a element according to `getCacheFullRemoveType()`
`CacheObject<V>`	`get(K key)` get element
`CacheFullRemoveType<V>`	`getCacheFullRemoveType()` get remove type when cache is full
`long`	`getHitCount()` get hit count
`double`	`getHitRate()` get hit rate
`int`	`getMaxSize()` get the maximum capacity of the cache
`long`	`getMissCount()` get miss count
`int`	`getSize()` get the number of elements in the cache valid
`long`	`getValidTime()` get valid time of elements in cache, in mills.
`protected boolean`	`isExpired(CacheObject<V> obj)` returns whether the element of the specified key has invalided if `getValidTime()` less than 0, return false, else if element is null, return true, else if `CacheObject.isExpired()` is true and `CacheObject.isForever()` is false, return true, else if `CacheObject.getEnterTime()` add `getValidTime()` less than current time, return true return false
`protected boolean`	`isExpired(K key)` whether the element of the specified key has invalided
`Set<K>`	`keySet()` key set
`static <K,V> SimpleCache<K,V>`	`loadCache(String filePath)` restore cache from file
`CacheObject<V>`	`put(K key, CacheObject<V> value)` put element, key and value both not allowed to be null
`CacheObject<V>`	`put(K key, V value)` put element, key not allowed to be null
`void`	`putAll(Cache<K,V> cache2)` pull all elements of cache2 to this
`CacheObject<V>`	`remove(K key)` remove the specified key from cache, key not allowed to be null
`protected int`	`removeExpired()` remove invalid elements
`static <K,V> void`	`saveCache(String filePath, SimpleCache<K,V> cache)` save cache to file, the data of `CacheObject` should can be serializabled
`void`	`setCacheFullRemoveType(CacheFullRemoveType<V> cacheFullRemoveType)` set remove type when cache is full
`protected void`	`setUsedInfo(CacheObject<V> obj)` set used info
`void`	`setValidTime(long validTime)` set valid time of elements in cache, in mills
`Collection<CacheObject<V>>`	`values()` value set

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

- 字段详细资料
  - DEFAULT_MAX_SIZE
```
public static final int DEFAULT_MAX_SIZE
```
    default maximum capacity of the cache
    
    另请参阅:
    常量字段值
  - cache
```
protected Map<K,CacheObject<V>> cache
```
    map to storage element
  - hitCount
```
protected AtomicLong hitCount
```
    hit count of cache
  - missCount
```
protected AtomicLong missCount
```
    miss count of cache
- 构造器详细资料
  - SimpleCache
```
public SimpleCache()
```
    - Maximum size of the cache is DEFAULT_MAX_SIZE
    - Elements of the cache will not invalid, can set by setValidTime(long)
    - Remove type is RemoveTypeEnterTimeFirst when cache is full
  - SimpleCache
```
public SimpleCache(int maxSize)
```
    - Elements of the cache will not invalid, can set by setValidTime(long)
    - Remove type is RemoveTypeEnterTimeFirst when cache is full
    参数:
    maxSize - maximum size of the cache
- 方法详细资料
  - getMaxSize
```
public int getMaxSize()
```
    get the maximum capacity of the cache
    
    返回:
  - getValidTime
```
public long getValidTime()
```
    get valid time of elements in cache, in mills. It means not invalid if less than 0
    
    返回:
  - setValidTime
```
public void setValidTime(long validTime)
```
    set valid time of elements in cache, in mills
    
    参数:
    validTime - valid time of elements in cache, in mills. If less than 0, it will be set to -1 and means not invalid. Rule of invalid see isExpired(CacheObject)
  - getCacheFullRemoveType
```
public CacheFullRemoveType<V> getCacheFullRemoveType()
```
    get remove type when cache is full
    
    返回:
  - setCacheFullRemoveType
```
public void setCacheFullRemoveType(CacheFullRemoveType<V> cacheFullRemoveType)
```
    set remove type when cache is full
    
    参数:
    cacheFullRemoveType - the cacheFullRemoveType to set
  - getSize
```
public int getSize()
```
    get the number of elements in the cache valid
    
    指定者:
    
    getSize 在接口中 Cache<K,V>
    
    返回:
  - get
```
public CacheObject<V> get(K key)
```
    get element
    
    指定者:
    
    get 在接口中 Cache<K,V>
    
    参数:
    key -
    
    返回:
    element if this cache contains the specified key and the element is valid, null otherwise.
  - setUsedInfo
```
protected void setUsedInfo(CacheObject<V> obj)
```
    set used info
    
    参数:
    obj -
  - put
```
public CacheObject<V> put(K key,
                 V value)
```
    put element, key not allowed to be null
    
    指定者:
    
    put 在接口中 Cache<K,V>
    
    参数:
    key - key
    value - data of CacheObject
    
    返回:
    return null if cache is full and cannot remove one, else return the value be putted
    另请参阅:
    put(Object, CacheObject)
  - put
```
public CacheObject<V> put(K key,
                 CacheObject<V> value)
```
    put element, key and value both not allowed to be null
    
    指定者:
    
    put 在接口中 Cache<K,V>
    
    参数:
    key -
    value -
    
    返回:
    return null if cache is full and cannot remove one, else return the value be putted
  - putAll
```
public void putAll(Cache<K,V> cache2)
```
    pull all elements of cache2 to this
    
    指定者:
    
    putAll 在接口中 Cache<K,V>
    
    参数:
    cache2 -
  - containsKey
```
public boolean containsKey(K key)
```
    whether this cache contains the specified key.
    
    指定者:
    
    containsKey 在接口中 Cache<K,V>
    
    参数:
    key -
    
    返回:
    true if this cache contains the specified key and the element is valid, false otherwise.
  - isExpired
```
protected boolean isExpired(K key)
```
    whether the element of the specified key has invalided
    
    参数:
    key -
    
    返回:
    另请参阅:
    isExpired(CacheObject)
  - remove
```
public CacheObject<V> remove(K key)
```
    remove the specified key from cache, key not allowed to be null
    
    指定者:
    
    remove 在接口中 Cache<K,V>
    
    参数:
    key -
    
    返回:
    the value of the removed or null if no mapping for the specified key was found.
  - fullRemoveOne
```
protected CacheObject<V> fullRemoveOne()
```
    remove a element when cache is full. according to getCacheFullRemoveType()
    - if getCacheFullRemoveType() is instance of RemoveTypeNotRemove return null, else
    - remove a element according to getCacheFullRemoveType()
    参数:
    key -
    
    返回:
    the value of the removed or null if no element can be remove.
  - removeExpired
```
protected int removeExpired()
```
    remove invalid elements
    
    返回:
    the count be removed
  - clear
```
public void clear()
```
    Removes all elements from this Map, leaving it empty.
    
    指定者:
    
    clear 在接口中 Cache<K,V>
    
    另请参阅:
    Map.clear()
  - isExpired
```
protected boolean isExpired(CacheObject<V> obj)
```
    returns whether the element of the specified key has invalided
    - if getValidTime() less than 0, return false, else
    - if element is null, return true, else
    - if CacheObject.isExpired() is true and CacheObject.isForever() is false, return true, else
    - if CacheObject.getEnterTime() add getValidTime() less than current time, return true
    - return false
    参数:
    obj -
    
    返回:
  - getHitCount
```
public long getHitCount()
```
    get hit count
  - getMissCount
```
public long getMissCount()
```
    get miss count
  - getHitRate
```
public double getHitRate()
```
    get hit rate
    
    指定者:
    
    getHitRate 在接口中 Cache<K,V>
    
    返回:
  - keySet
```
public Set<K> keySet()
```
    从接口复制的说明: Cache
    
    key set
    
    指定者:
    
    keySet 在接口中 Cache<K,V>
    
    返回:
    a set of the keys.
    另请参阅:
    Map.keySet()
  - entrySet
```
public Set<Map.Entry<K,CacheObject<V>>> entrySet()
```
    从接口复制的说明: Cache
    
    key value set
    
    指定者:
    
    entrySet 在接口中 Cache<K,V>
    
    返回:
    a set of the mappings
    另请参阅:
    Map.entrySet()
  - values
```
public Collection<CacheObject<V>> values()
```
    从接口复制的说明: Cache
    
    value set
    
    指定者:
    
    values 在接口中 Cache<K,V>
    
    返回:
    a collection of the values contained in this cache.
    另请参阅:
    Map.values()
  - loadCache
```
public static <K,V> SimpleCache<K,V> loadCache(String filePath)
```
    restore cache from file
    
    参数:
    filePath -
    
    返回:
  - saveCache
```
public static <K,V> void saveCache(String filePath,
                   SimpleCache<K,V> cache)
```
    save cache to file, the data of CacheObject should can be serializabled
    
    类型参数:
    K -
    V -
    参数:
    filePath -
    cache -

类 SimpleCache<K,V>

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_MAX_SIZE

cache

hitCount

missCount

构造器详细资料

SimpleCache

SimpleCache

方法详细资料

getMaxSize

getValidTime

setValidTime

getCacheFullRemoveType

setCacheFullRemoveType

getSize

get

setUsedInfo

put

put

putAll

containsKey

isExpired

remove

fullRemoveOne

removeExpired

clear

isExpired

getHitCount

getMissCount

getHitRate

keySet

entrySet

values

loadCache

saveCache