001: /*--
002:
003: Copyright (C) 2000-2003 Anthony Eden.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The name "EdenLib" must not be used to endorse or promote products
019: derived from this software without prior written permission. For
020: written permission, please contact me@anthonyeden.com.
021:
022: 4. Products derived from this software may not be called "EdenLib", nor
023: may "EdenLib" appear in their name, without prior written permission
024: from Anthony Eden (me@anthonyeden.com).
025:
026: In addition, I request (but do not require) that you include in the
027: end-user documentation provided with the redistribution and/or in the
028: software itself an acknowledgement equivalent to the following:
029: "This product includes software developed by
030: Anthony Eden (http://www.anthonyeden.com/)."
031:
032: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
033: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
034: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
035: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
036: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
037: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
038: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
039: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
040: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
041: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
042: POSSIBILITY OF SUCH DAMAGE.
043:
044: For more information on EdenLib, please see <http://edenlib.sf.net/>.
045:
046: */
047:
048: package com.anthonyeden.lib.cache;
049:
050: import com.anthonyeden.lib.config.Configuration;
051: import com.anthonyeden.lib.config.ConfigurationException;
052:
053: /** Base interface for Cache implementations.
054:
055: @author Anthony Eden
056: @since 1.1
057: */
058:
059: public interface Cache {
060:
061: /** Get the value for the given key from the cache. This method may
062: return null if there is no value or the value is expired.
063:
064: @param key The key
065: @return The value or null
066: */
067:
068: public Object get(Object key);
069:
070: /** Insert a value into the cache.
071:
072: @param key The key
073: @param value The value
074: */
075:
076: public void put(Object key, Object value);
077:
078: /** Insert a value into the cache with the specified time to live.
079: The specified time to live overrides the default time to live.
080: A value less than 0 is be considered as "infinate".
081:
082: @param key The key
083: @param value The value
084: @param ttl The time to live
085: */
086:
087: public void put(Object key, Object value, int ttl);
088:
089: /** Remove a value from the cache.
090:
091: @param key The key
092: */
093:
094: public void remove(Object key);
095:
096: /** Get the default time to live.
097:
098: @return The default time to live
099: */
100:
101: public int getTTL();
102:
103: /** Set the default time to live.
104:
105: @param ttl The new default time to live
106: */
107:
108: public void setTTL(int ttl);
109:
110: /** Load the Cache's configuration from the given Configuration object.
111:
112: @param configuration The Configuration object
113: @throws ConfigurationException
114: */
115:
116: public void loadConfiguration(Configuration configuration)
117: throws ConfigurationException;
118:
119: }
|