org.apache.oro.util

Class GenericCache

public abstract class GenericCache extends Object implements Cache, 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.

Since: 1.0

Version: 2.0.8

See Also: Cache CacheLRU CacheFIFO CacheFIFO2 CacheRandom

Field Summary
static intDEFAULT_CAPACITY
The default capacity to be used by the GenericCache subclasses provided with this package.
Method Summary
abstract voidaddElement(Object key, Object value)
intcapacity()
Returns the maximum number of elements that can be cached at one time.
ObjectgetElement(Object key)
booleanisFull()
Iteratorkeys()
intsize()
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 Detail

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.

Method Detail

addElement

public abstract void addElement(Object key, Object value)

capacity

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

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

getElement

public Object getElement(Object key)

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.

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.