org.tinygroup.cache

Interface Cache

All Known Implementing Classes:

EhCache, JcsCache, MultiCache, RedisCache

public interface Cache

功能说明: 缓存通用接口

开发人员: renhui
开发时间: 2013-5-22

Method Summary

Modifier and Type	Method and Description
void	cleanGroup(String group) 清除指定组下的所有缓存
void	clear() 清除缓存实例下所有缓存内容
void	destroy() 销毁缓存实例相关的资源
int	freeMemoryElements(int numberToFree) 释放指定数目的缓存内容，各个第三方缓存实现机制可能不一样
Object	get(String key) 获取key对应的缓存值
Object[]	get(String[] keys) 分别获取key数组中对应的缓存值
Object	get(String group, String key) 从指定组中的缓存中获取key对应的缓存值
Object[]	get(String group, String[] keys) 从指定组中的缓存中分别获取keys对应的缓存值，以值数组形式返回
Set<String>	getGroupKeys(String group) 获取指定组下所有缓存key列表
String	getStats() 返回次数缓存的状态快照
void	init(String region) 缓存区域初始化
void	put(String key, Object object) 缓存内容存储接口
void	put(String groupName, String key, Object object) 缓存内容存储接口
void	putSafe(String key, Object object) 缓存内容存储接口,与put不同的是，此方法会先根据key判断缓存是否已经存在
void	remove(String key) 移除key对应的缓存内容
void	remove(String[] keys) 移除缓存key数组对应的缓存内容
void	remove(String group, String key) 移除指定组下缓存名称为key的缓存
void	remove(String group, String[] keys) 移除指定组下缓存key数组对应的缓存内容
void	setCacheManager(CacheManager manager) 设置此缓存关联的缓存管理器

Method Detail

init

void init(String region)

缓存区域初始化

参考org.tinygroup.cache.CacheManager.createCache(region)

Parameters:

region - 缓存区域

get

Object get(String key)

获取key对应的缓存值

Parameters:

key - 缓存key

Returns:

返回key对应的缓存值

get

Object get(String group,
           String key)

从指定组中的缓存中获取key对应的缓存值

Parameters:

groupName - 缓存分组

key - 缓存名称

Returns:

缓存值

get

Object[] get(String[] keys)

分别获取key数组中对应的缓存值

Parameters:

keys - 缓存名称数组

Returns:

返回keys对应的缓存值数组

get

Object[] get(String group,
             String[] keys)

从指定组中的缓存中分别获取keys对应的缓存值，以值数组形式返回

Parameters:

groupName - 缓存分组名

keys - 缓存名称数组

Returns:

返回缓存值数组

put

void put(String key,
         Object object)

缓存内容存储接口

Parameters:

key - 缓存名称

Object - 缓存值

putSafe

void putSafe(String key,
             Object object)

缓存内容存储接口,与put不同的是，此方法会先根据key判断缓存是否已经存在

Parameters:

key -

Object -

put

void put(String groupName,
         String key,
         Object object)

缓存内容存储接口

Parameters:

groupName - 缓存分组

key - 缓存名称

object - 缓存值

getGroupKeys

Set<String> getGroupKeys(String group)

获取指定组下所有缓存key列表

Parameters:

group - 缓存分组

Returns:

返回缓存key列表

cleanGroup

void cleanGroup(String group)

清除指定组下的所有缓存

Parameters:

group - 缓存分组

clear

void clear()

清除缓存实例下所有缓存内容

remove

void remove(String key)

移除key对应的缓存内容

Parameters:

key - 缓存名称

remove

void remove(String group,
            String key)

移除指定组下缓存名称为key的缓存

Parameters:

group - 缓存分组

key - 缓存名称

remove

void remove(String[] keys)

移除缓存key数组对应的缓存内容

Parameters:

keys - 缓存key数组

remove

void remove(String group,
            String[] keys)

移除指定组下缓存key数组对应的缓存内容

Parameters:

group - 缓存分组

keys - 缓存key数组

getStats

String getStats()

返回次数缓存的状态快照

Returns:

次数缓存状态组装成的字符串信息

freeMemoryElements

int freeMemoryElements(int numberToFree)

释放指定数目的缓存内容，各个第三方缓存实现机制可能不一样

Parameters:

numberToFree - 要释放的缓存数目

Returns:

真正被释放的缓存数目

destroy

void destroy()

销毁缓存实例相关的资源

setCacheManager

void setCacheManager(CacheManager manager)

设置此缓存关联的缓存管理器

Parameters:

manager - 缓存管理器