com.xiaoleilu.hutool.cache.Cache Maven / Gradle / Ivy

Go to download
package com.xiaoleilu.hutool.cache;

import java.util.Iterator;

/**
 * 缓存接口
 * @author Looly,jodd
 *
 * @param  键类型
 * @param  值类型
 */
public interface Cache extends Iterable{

	/**
	 * 返回缓存容量，0表示无大小限制
	 * @return 返回缓存容量，0表示无大小限制
	 */
	int capacity();

	/**
	 *  缓存失效时长， 0 表示没有设置，单位毫秒
	 * @return 缓存失效时长， 0 表示没有设置，单位毫秒
	 */
	long timeout();

	/**
	 * 将对象加入到缓存，使用默认失效时长
	 * @param key 键
	 * @param object 缓存的对象
	 * @see Cache#put(Object, Object, long)
	 */
	void put(K key, V object);

	/**
	 * 将对象加入到缓存，使用指定失效时长

	 * 如果缓存空间满了，{@link #prune()} 将被调用以获得空间来存放新对象
	 * @param key 键
	 * @param object 缓存的对象
	 * @param timeout 失效时长，单位毫秒
	 * @see Cache#put(Object, Object, long)
	 */
	void put(K key, V object, long timeout);

	/**
	 * 从缓存中获得对象，当对象不在缓存中或已经过期返回null
	 * @param key 键
	 * @return 键对应的对象
	 */
	V get(K key);

	/**
	 * 返回缓存迭代器
	 * @return 缓存迭代器
	 */
	@Override
	Iterator iterator();

	/**
	 * 从缓存中清理过期对象，清理策略取决于具体实现
	 * @return 清理的缓存对象个数
	 */
	int prune();

	/**
	 * 缓存是否已满，仅用于有空间限制的缓存对象
	 * @return 缓存是否已满，仅用于有空间限制的缓存对象
	 */
	boolean isFull();

	/**
	 * 从缓存中移除对象
	 * @param key 键
	 */
	void remove(K key);

	/**
	 * 清空缓存
	 */
	void clear();

	/**
	 * 缓存的对象数量
	 * @return 缓存的对象数量
	 */
	int size();

	/**
	 * 缓存是否为空
	 * @return 缓存是否为空
	 */
	boolean isEmpty();
	
	/**
	 * 是否包含key
	 * @param key KEY
	 * @return 是否包含key
	 */
	boolean containsKey(K key);
}