IPersistentObjectCache.java

/*******************************************************************************
 * Copyright (c) 2007-2011, G. Weirich and Elexis
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     G. Weirich - initial API and implementation
 ******************************************************************************/
package ch.elexis.core.data.cache;


public interface IPersistentObjectCache<K> {
	
	/**
	 * Insert an Object that will stay until it is manually removed, or memory gets low, or at most
	 * for ICacheable#getCacheTime seconds
	 */
	public void put(final K key, final Object object, final int timeToCacheInSeconds);
	
	/**
	 * retrieve a previously inserted object
	 * 
	 * @return the object or null, if the object was expired or removed bei the garbage collector.
	 */
	public Object get(final K key);
	
	/**
	 * 
	 * @param key
	 * @param timeToCacheInSeconds
	 * @return
	 * @since 3.1
	 */
	public Object get(final K key, final int timeToCacheInSeconds);
	
	public void remove(final K key);
	
	public void clear();
	
	/**
	 * write statistics to log
	 */
	public void stat();
	
	/**
	 * Expire and remove all Objects (without removing the SoftReferences, to avoid
	 * ConcurrentModificationExceptions)
	 * 
	 */
	public void purge();
	
	/**
	 * completely delete cache
	 */
	public void reset();

}