org.apache.oro.util

Class GenericCache

Implemented Interfaces:
Cache, java.io.Serializable
Known Direct Subclasses:
CacheFIFO, CacheFIFO2, CacheLRU, CacheRandom

public abstract class GenericCache
extends java.lang.Object
implements Cache, java.io.Serializable

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 Cache interface.

Version:
2.0.8

Since:
1.0

See Also:
Cache, CacheLRU, CacheFIFO, CacheFIFO2, CacheRandom, Serialized Form

Field Summary

static int
DEFAULT_CAPACITY
The default capacity to be used by the GenericCache subclasses provided with this package.

Method Summary

void
addElement(Object key, Object value)
int
capacity()
Returns the maximum number of elements that can be cached at one time.
Object
getElement(Object key)
boolean
isFull()
Iterator
keys()
int
size()
Returns the number of elements in the cache, not to be confused with the capacity() which returns the number of elements that can be held in the cache at one time.

Field Details

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY
The default capacity to be used by the GenericCache subclasses provided with this package. Its value is 20.

Field Value:
20

Method Details

addElement

public void addElement(Object key,
                       Object value)
Specified by:
addElement in interface Cache


capacity

public final int capacity()
Returns the maximum number of elements that can be cached at one time.

Specified by:
capacity in interface Cache

Returns:
The maximum number of elements that can be cached at one time.


getElement

public Object getElement(Object key)
Specified by:
getElement in interface Cache


isFull

public final boolean isFull()


keys

public final Iterator keys()


size

public final int size()
Returns the number of elements in the cache, not to be confused with the capacity() which returns the number of elements that can be held in the cache at one time.

Specified by:
size in interface Cache

Returns:
The current size of the cache (i.e., the number of elements currently cached).


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.