net.ymate.platform.cache

Interface ICache

All Superinterfaces:

AutoCloseable, IDestroyable

All Known Implementing Classes:

EhCacheWrapper, MultilevelCacheWrapper, RedisCacheWrapper

@Ignored
public interface ICache
extends IDestroyable

缓存接口定义

Author:

刘镇 (suninformation@163.com) on 14/10/17

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT
static String	MULTILEVEL
static String	REDIS

Method Summary

Modifier and Type	Method and Description
ICacheLocker	acquireCacheLocker() 获取缓存锁对象，若缓存实例不支持则返回null
void	clear() 清理缓存
Object	get(Object key) 从缓存中获取对象
List<?>	keys() 获取当前所有缓存对象key的集合
void	put(Object key, Object value) 添加对象到缓存
void	put(Object key, Object value, int timeout) 添加对象到缓存
void	remove(Object key) 从缓存中移除对象
void	removeAll(Collection<?> keys) 批量从缓存中移除对象
void	update(Object key, Object value) 更新对象到缓存
void	update(Object key, Object value, int timeout) 更新对象到缓存

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

DEFAULT

static final String DEFAULT

See Also:

Constant Field Values

REDIS

static final String REDIS

See Also:

Constant Field Values

MULTILEVEL

static final String MULTILEVEL

See Also:

Constant Field Values

Method Detail

get

Object get(Object key)
    throws CacheException

从缓存中获取对象

Parameters:

key - 缓存key

Returns:

返回缓存的对象，若不存在则返回null

Throws:

CacheException - 可能产生的异常

put

void put(Object key,
         Object value)
  throws CacheException

添加对象到缓存

Parameters:

key - 缓存key

value - 预缓存的元素对象

Throws:

CacheException - 可能产生的异常

put

void put(Object key,
         Object value,
         int timeout)
  throws CacheException

添加对象到缓存

Parameters:

key - 缓存key

value - 预缓存的元素对象

timeout - 自定义超时时间（秒），若为0则使用默认值

Throws:

CacheException - 可能产生的异常

update

void update(Object key,
            Object value)
     throws CacheException

更新对象到缓存

Parameters:

key - 缓存key

value - 预缓存的元素对象

Throws:

CacheException - 可能产生的异常

update

void update(Object key,
            Object value,
            int timeout)
     throws CacheException

更新对象到缓存

Parameters:

key - 缓存key

value - 预缓存的元素对象

timeout - 自定义超时时间（秒），若为0则使用默认值

Throws:

CacheException - 可能产生的异常

keys

List<?> keys()
      throws CacheException

获取当前所有缓存对象key的集合

Returns:

返回当前所有缓存对象key的集合

Throws:

CacheException - 可能产生的异常

remove

void remove(Object key)
     throws CacheException

从缓存中移除对象

Parameters:

key - 缓存key

Throws:

CacheException - 可能产生的异常

removeAll

void removeAll(Collection<?> keys)
        throws CacheException

批量从缓存中移除对象

Parameters:

keys - 缓存key集合

Throws:

CacheException - 可能产生的异常

clear

void clear()
    throws CacheException

清理缓存

Throws:

CacheException - 可能产生的异常

acquireCacheLocker

ICacheLocker acquireCacheLocker()

获取缓存锁对象，若缓存实例不支持则返回null

Returns:

返回缓存锁对象