|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/oro-2.0.8/org/apache/oro/util/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>GenericCache (Jakarta-ORO 2.0.8 API)</title><script src="../../../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="org.apache.oro.util.GenericCache class"/><meta name="keywords" content="DEFAULT_CAPACITY"/><meta name="keywords" content="addElement()"/><meta name="keywords" content="getElement()"/><meta name="keywords" content="keys()"/><meta name="keywords" content="size()"/><meta name="keywords" content="capacity()"/><meta name="keywords" content="isFull()"/><link rel="stylesheet" type="text/css" href="../../../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../../about.html">About</a></span></div></td><td class="header" rowspan="2"><a href='http://jakarta.apache.org/oro/' target=_top><img src='{@docroot}/../images/logoSmall.gif' alt='Jakarta ORO' width=48 height=47 align=center border=0 hspace=1 vspace=1></a></td></tr><tr><td class="navi"><a href="../../../../org/apache/oro/util/CacheRandom.html">Prev Class</a> | Next Class</td><td class="navi"><a href="../../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="GenericCache.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">org.apache.oro.util</h3><h1 class="class title-class">Class GenericCache</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>org.apache.oro.util.GenericCache</code></li><li></li></ul></li></ul></div><dl class="class knownimplementing"><dt class="header"><b>Implemented Interfaces:</b></dt><dd class="item"><a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a>, java.io.Serializable</dd></dl><dl class="class subclasses"><dt class="class subclasses header"><b>Known Direct Subclasses:</b></dt><dd class="class subclasses header"><a href="../../../../org/apache/oro/util/CacheFIFO.html" title="Class in org.apache.oro.util">CacheFIFO</a>, <a href="../../../../org/apache/oro/util/CacheFIFO2.html" title="Class in org.apache.oro.util">CacheFIFO2</a>, <a href="../../../../org/apache/oro/util/CacheLRU.html" title="Class in org.apache.oro.util">CacheLRU</a>, <a href="../../../../org/apache/oro/util/CacheRandom.html" title="Class in org.apache.oro.util">CacheRandom</a></dd></b></dt></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public abstract class <b class="class synopsis name">GenericCache</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div><div class="class synopsis implements"><code>implements <a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a>, java.io.Serializable</code></div></div><hr/><div class="class description"> This is the base class for all cache implementations provided in the
org.apache.oro.util package. To derive a subclass from GenericCache
only the ... methods
need be overridden.
Although 4 subclasses of GenericCache are provided with this
package, users may not derive subclasses from this class.
Rather, users should create their own implmentations of the
<a href="../../../../org/apache/oro/util/Cache.html"><code>Cache</code></a> interface.
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>2.0.8</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>1.0</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../../org/apache/oro/util/Cache.html"><code>Cache</code></a>, <a href="../../../../org/apache/oro/util/CacheLRU.html"><code>CacheLRU</code></a>, <a href="../../../../org/apache/oro/util/CacheFIFO.html"><code>CacheFIFO</code></a>, <a href="../../../../org/apache/oro/util/CacheFIFO2.html"><code>CacheFIFO2</code></a>, <a href="../../../../org/apache/oro/util/CacheRandom.html"><code>CacheRandom</code></a>, <a href="../../../../serialized-form.html#org.apache.oro.util.GenericCache">Serialized Form</a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#DEFAULT_CAPACITY">DEFAULT_CAPACITY</a></code></dt><dd class="description"> The default capacity to be used by the GenericCache subclasses
provided with this package.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">abstract void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#addElement(Object,Object)">addElement</a>(Object key, Object value)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#capacity()">capacity</a>()</code></dt><dd class="description"> Returns the maximum number of elements that can be cached at one time.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Object</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getElement(Object)">getElement</a>(Object key)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#isFull()">isFull</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Iterator</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#keys()">keys</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#size()">size</a>()</code></dt><dd class="description"> Returns the number of elements in the cache, not to be confused with
the <a href="../../../../org/apache/oro/util/GenericCache.html#capacity()"><code>capacity()</code></a> which returns the number
of elements that can be held in the cache at one time.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="DEFAULT_CAPACITY" id="DEFAULT_CAPACITY"/><div class="member detail outer"><h3 class="member detail name">DEFAULT_CAPACITY</h3><pre class="member detail synopsis">public static final int DEFAULT_CAPACITY</pre><blockquote class="member detail name"><div class="member detail description"> The default capacity to be used by the GenericCache subclasses
provided with this package. Its value is 20.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">20</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="addElement(Object,Object)" id="addElement(Object,Object)"/><div class="member detail outer"><h3 class="member detail name">addElement</h3><pre class="member detail synopsis">public abstract void addElement(Object key,
Object value)</pre><blockquote class="member detail name"><div class="member detail description"></div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../../../../org/apache/oro/util/Cache.html#addElement(Object,Object)">addElement</a> in interface <a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a></dd></dl><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="capacity()" id="capacity()"/><div class="member detail outer"><h3 class="member detail name">capacity</h3><pre class="member detail synopsis">public final int capacity()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the maximum number of elements that can be cached at one time.
<p/>
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../../../../org/apache/oro/util/Cache.html#capacity()">capacity</a> in interface <a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a></dd></dl><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The maximum number of elements that can be cached at one time.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getElement(Object)" id="getElement(Object)"/><div class="member detail outer"><h3 class="member detail name">getElement</h3><pre class="member detail synopsis">public Object getElement(Object key)</pre><blockquote class="member detail name"><div class="member detail description"></div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../../../../org/apache/oro/util/Cache.html#getElement(Object)">getElement</a> in interface <a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a></dd></dl><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="isFull()" id="isFull()"/><div class="member detail outer"><h3 class="member detail name">isFull</h3><pre class="member detail synopsis">public final boolean isFull()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="keys()" id="keys()"/><div class="member detail outer"><h3 class="member detail name">keys</h3><pre class="member detail synopsis">public final Iterator keys()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="size()" id="size()"/><div class="member detail outer"><h3 class="member detail name">size</h3><pre class="member detail synopsis">public final int size()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the number of elements in the cache, not to be confused with
the <a href="../../../../org/apache/oro/util/GenericCache.html#capacity()"><code>capacity()</code></a> which returns the number
of elements that can be held in the cache at one time.
<p/>
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../../../../org/apache/oro/util/Cache.html#size()">size</a> in interface <a href="../../../../org/apache/oro/util/Cache.html" title="Interface in org.apache.oro.util">Cache</a></dd></dl><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The current size of the cache (i.e., the number of elements
currently cached).</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../../about.html">About</a></span></div></td></tr></table><hr/>Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.</body></html>