
net.sf.ehcache.store.Store Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of megamap Show documentation
Show all versions of megamap Show documentation
A simple, unbounded hashtable for Java
The newest version!
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 - 2004 Greg Luck. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by Greg Luck
* (http://sourceforge.net/users/gregluck) and contributors.
* See http://sourceforge.net/project/memberlist.php?group_id=93232
* for a list of contributors"
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "EHCache" must not be used to endorse or promote products
* derived from this software without prior written permission. For written
* permission, please contact Greg Luck (gregluck at users.sourceforge.net).
*
* 5. Products derived from this software may not be called "EHCache"
* nor may "EHCache" appear in their names without prior written
* permission of Greg Luck.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL GREG LUCK OR OTHER
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by contributors
* individuals on behalf of the EHCache project. For more
* information on EHCache, please see .
*
*/
package net.sf.ehcache.store;
import net.sf.ehcache.Element;
import java.io.IOException;
import java.io.Serializable;
/**
* This is the interface for all stores. A store is a physical counterpart to a cache, which
* is a logical concept.
*
* @version $Id: Store.java,v 1.1.1.1 2005/01/27 18:15:03 pents90 Exp $
* @author Greg Luck
*/
public interface Store {
/** Composite, including memory cache, type and central hub. */
int CACHE_HUB = 1;
/** Disk cache type. */
int DISK_CACHE = 2;
/** Store alive status. */
int STATUS_UNINITIALISED = 1;
/** Store alive status. */
int STATUS_ALIVE = 2;
/** Store disposed status. */
int STATUS_DISPOSED = 3;
/** Store in error. */
int STATUS_ERROR = 4;
/** Puts an item into the cache. */
void put(Element element) throws IOException;
/** Gets an item from the cache. */
Element get(Serializable key) throws IOException;
/** Removes an item from the cache. */
boolean remove(Serializable key) throws IOException;
/** Removes all cached items from the cache. */
void removeAll() throws IOException;
/** Prepares for shutdown. */
void dispose() throws IOException;
/** Returns the current cache size. */
int getSize();
/** Returns the cache status. */
int getStatus();
/** Returns the cache name. */
String getName();
/**
* Returns the cache type.
* @return The cacheType value
*/
int getCacheType();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy