Cache (java-sdk-common 1.0.0 API)

类型参数:

K - 键类型

V - 值类型

所有超级接口:

Iterable<V>, Serializable

所有已知实现类:

AbstractCache, FIFOCache, LFUCache, LRUCache, NoCache, TimedCache, WeakCache
```
public interface Cache<K,V>
extends Iterable<V>, Serializable
```
缓存接口

作者:

Looly,jodd

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`Iterator<CacheObj<K,V>>`	`cacheObjIterator()` 返回包含键和值得迭代器
`int`	`capacity()` 返回缓存容量，`0`表示无大小限制
`void`	`clear()` 清空缓存
`boolean`	`containsKey(K key)` 是否包含key
`V`	`get(K key)` 从缓存中获得对象，当对象不在缓存中或已经过期返回`null` 调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回`null`，否则返回值。
`V`	`get(K key, boolean isUpdateLastAccess)` 从缓存中获得对象，当对象不在缓存中或已经过期返回`null` 调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回`null`，否则返回值。
`V`	`get(K key, Func0<V> supplier)` 从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象
`boolean`	`isEmpty()` 缓存是否为空
`boolean`	`isFull()` 缓存是否已满，仅用于有空间限制的缓存对象
`Iterator<V>`	`iterator()` 返回缓存迭代器
`int`	`prune()` 从缓存中清理过期对象，清理策略取决于具体实现
`void`	`put(K key, V object)` 将对象加入到缓存，使用默认失效时长
`void`	`put(K key, V object, long timeout)` 将对象加入到缓存，使用指定失效时长如果缓存空间满了，`prune()` 将被调用以获得空间来存放新对象
`void`	`remove(K key)` 从缓存中移除对象
`int`	`size()` 缓存的对象数量
`long`	`timeout()` 缓存失效时长， `0` 表示没有设置，单位毫秒

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 方法详细资料
  - capacity
```
int capacity()
```
    返回缓存容量，0表示无大小限制
    
    返回:
    
    返回缓存容量，0表示无大小限制
  - timeout
```
long timeout()
```
    缓存失效时长， 0 表示没有设置，单位毫秒
    
    返回:
    
    缓存失效时长， 0 表示没有设置，单位毫秒
  - put
```
void put(K key,
         V object)
```
    将对象加入到缓存，使用默认失效时长
    
    参数:
    
    key - 键
    
    object - 缓存的对象
    
    另请参阅:
    
    put(Object, Object, long)
  - put
```
void put(K key,
         V object,
         long timeout)
```
    将对象加入到缓存，使用指定失效时长
    如果缓存空间满了，prune() 将被调用以获得空间来存放新对象
    
    参数:
    
    key - 键
    
    object - 缓存的对象
    
    timeout - 失效时长，单位毫秒
    
    另请参阅:
    
    put(Object, Object, long)
  - get
```
V get(K key)
```
    从缓存中获得对象，当对象不在缓存中或已经过期返回null
    调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。
    每次调用此方法会刷新最后访问时间，也就是说会重新计算超时时间。
    
    参数:
    
    key - 键
    
    返回:
    
    键对应的对象
    
    另请参阅:
    
    get(Object, boolean)
  - get
```
V get(K key,
      Func0<V> supplier)
```
    从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象
    
    参数:
    
    key - 键
    
    supplier - 如果不存在回调方法，用于生产值对象
    
    返回:
    
    值对象
  - get
```
V get(K key,
      boolean isUpdateLastAccess)
```
    从缓存中获得对象，当对象不在缓存中或已经过期返回null
    调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。
    
    参数:
    
    key - 键
    
    isUpdateLastAccess - 是否更新最后访问时间，即重新计算超时时间。
    
    返回:
    
    键对应的对象
  - iterator
```
Iterator<V> iterator()
```
    返回缓存迭代器
    
    指定者:
    
    iterator 在接口中 Iterable<V>
    
    返回:
    
    缓存迭代器
  - cacheObjIterator
```
Iterator<CacheObj<K,V>> cacheObjIterator()
```
    返回包含键和值得迭代器
    
    返回:
    
    缓存对象迭代器
    
    从以下版本开始:
    
    4.0.10
  - prune
```
int prune()
```
    从缓存中清理过期对象，清理策略取决于具体实现
    
    返回:
    
    清理的缓存对象个数
  - isFull
```
boolean isFull()
```
    缓存是否已满，仅用于有空间限制的缓存对象
    
    返回:
    
    缓存是否已满，仅用于有空间限制的缓存对象
  - remove
```
void remove(K key)
```
    从缓存中移除对象
    
    参数:
    
    key - 键
  - clear
```
void clear()
```
    清空缓存
  - size
```
int size()
```
    缓存的对象数量
    
    返回:
    
    缓存的对象数量
  - isEmpty
```
boolean isEmpty()
```
    缓存是否为空
    
    返回:
    
    缓存是否为空
  - containsKey
```
boolean containsKey(K key)
```
    是否包含key
    
    参数:
    
    key - KEY
    
    返回:
    
    是否包含key

接口 Cache<K,V>

方法概要

从接口继承的方法 java.lang.Iterable

方法详细资料

capacity

timeout

put

put

get

get

get

iterator

cacheObjIterator

prune

isFull

remove

clear

size

isEmpty

containsKey