01: /*
02: * $Id: Cache.java,v 1.7 2003/11/07 20:16:25 dfs Exp $
03: *
04: * ====================================================================
05: * The Apache Software License, Version 1.1
06: *
07: * Copyright (c) 2000 The Apache Software Foundation. All rights
08: * reserved.
09: *
10: * Redistribution and use in source and binary forms, with or without
11: * modification, are permitted provided that the following conditions
12: * are met:
13: *
14: * 1. Redistributions of source code must retain the above copyright
15: * notice, this list of conditions and the following disclaimer.
16: *
17: * 2. Redistributions in binary form must reproduce the above copyright
18: * notice, this list of conditions and the following disclaimer in
19: * the documentation and/or other materials provided with the
20: * distribution.
21: *
22: * 3. The end-user documentation included with the redistribution,
23: * if any, must include the following acknowledgment:
24: * "This product includes software developed by the
25: * Apache Software Foundation (http://www.apache.org/)."
26: * Alternately, this acknowledgment may appear in the software itself,
27: * if and wherever such third-party acknowledgments normally appear.
28: *
29: * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
30: * must not be used to endorse or promote products derived from this
31: * software without prior written permission. For written
32: * permission, please contact apache@apache.org.
33: *
34: * 5. Products derived from this software may not be called "Apache"
35: * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
36: * name, without prior written permission of the Apache Software Foundation.
37: *
38: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
39: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
40: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
41: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
42: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
44: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
46: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49: * SUCH DAMAGE.
50: * ====================================================================
51: *
52: * This software consists of voluntary contributions made by many
53: * individuals on behalf of the Apache Software Foundation. For more
54: * information on the Apache Software Foundation, please see
55: * <http://www.apache.org/>.
56: */
57:
58: package org.apache.oro.util;
59:
60: /**
61: * An interface defining the basic functions of a cache.
62: *
63: * @version @version@
64: * @since 1.0
65: */
66: public interface Cache {
67:
68: public void addElement(Object key, Object value);
69:
70: public Object getElement(Object key);
71:
72: /**
73: * Returns the number of elements in the cache, not to be confused with
74: * the {@link #capacity()} which returns the number
75: * of elements that can be held in the cache at one time.
76: * <p>
77: * @return The current size of the cache (i.e., the number of elements
78: * currently cached).
79: */
80: public int size();
81:
82: /**
83: * Returns the maximum number of elements that can be cached at one time.
84: * <p>
85: * @return The maximum number of elements that can be cached at one time.
86: */
87: public int capacity();
88:
89: }
|