• Home
• com.holmos
• holmos-cache
• 1.0.2u9
• source code
• Cache.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.holmos.cache.cache.Cache Maven / Gradle / Ivy

package com.holmos.cache.cache;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import com.holmos.cache.cache.listener.CacheListener;
import com.holmos.cache.config.CacheConfigComponent;
import com.holmos.cache.element.Element;
import com.holmos.cache.exception.CacheException;
import com.holmos.cache.loader.CacheLoader;
import com.holmos.cache.outpolicy.CacheOutPolicy;
import com.holmos.cache.status.CacheStatus;

/**
 * Holmos Watsen单层缓存系统,此接口为缓存功能接口,如果实现新的缓存需要继承此接口
 * @author: 吴银龙([email protected])
 * @version: 2013-3-7 下午7:33:41 
 */

public interface Cache {
	/**
	 * 向缓存里面放入一个元素
	 * 
	 * 
需要更新这个元素的一些属性信息，比如访问时间，访问次数等等，如果之前缓存中有此元素的话
	 * 
通知访问元素的监听器,触发一些事件
	 * 
如果此元素原来在缓存里面没有，则新增此元素；如果有，则更新此元素
	 * 
	 * @param element 待进行put操作的元素
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如element == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用put抛出此异常
	 * */
	public void put(Element element) throws IllegalArgumentException,IllegalStateException,
		CacheException;
	
	/**
	 * {@link #put(Element)}的批量操作方法
	 * 
	 * 
当集合中有一个Element为null 或者整个集合为null，抛出{@link IllegalArgumentException}
	 * 
其他功能和{@link #put(Element)}一致
	 * 
	 * @param elements 待进行put操作的元素集合
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如element == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用put抛出此异常
	 * */
	public void putAll(Collection elements) throws IllegalArgumentException, IllegalStateException,
    	CacheException;
	
	/**
	 * 同步put操作,等待element已经成功放入缓存内部之后返回
	 * 
	 * 
其他操作同{@link #put(Element)}
	 * 
	 * @param element 待进行put操作的元素
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如element == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用put抛出此异常
	 * */
	public void putSyn(Element element) throws IllegalArgumentException,IllegalStateException,
		CacheException;
	
	/**
	 * 不等待缓存元素成功放入缓存立即返回
	 * 
	 * 
其他操作同{@link #put(Element)}
	 * 
	 * @param element 待进行put操作的元素
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如element == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用put抛出此异常
	 * */
	public void putAsy(Element element) throws IllegalArgumentException,IllegalStateException,
		CacheException;
	
	/**
	 * put 操作的静默模式，不更新此数据的状态信息，比如访问次数，最近访问时间，不修改版本号，也不触发元素访问监听器，只是很简单的向缓存里面放入此数据
	 * 
	 * 
不更新缓存元素状态信息
	 * 
不触发缓存元素访问监听器
	 * 
	 * @param element 待进行put操作的元素
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如element == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用put抛出此异常
	 * */
	public void putQuite(Element element)  throws IllegalArgumentException,IllegalStateException,
		CacheException;
	
	/**
	 * 删除 索引 为key 的缓存元素
	 * 
	 * 
触发缓存元素访问监听器
	 * 
	 * @param key 待进行remove操作的元素的索引
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如key == null
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用remove抛出此异常
	 * @return true 删除成功
false 删除失败
	 * */
	public boolean remove(Object key) throws IllegalArgumentException,IllegalStateException,
		CacheException;
	
	/**
	 * {@link #remove(Object)}的批量操作
	 * 
	 * @param keys 待进行remove操作的元素的索引集合
	 * @throws CacheException 缓存系统出现异常所抛
	 * @throws IllegalArgumentException 当传入非法参数的时候，比如其中任何一个元素key == null，keys == null 的时候也抛出此异常
	 * @throws IllegalStateException 当缓存不处于服务状态的时候调用remove抛出此异常
	 * @return true 删除成功
false 删除失败
	 * */
	public boolean removeAll(Collection