Package org.apache.oro.util
Class GenericCache
java.lang.Object
org.apache.oro.util.GenericCache
- All Implemented Interfaces:
Serializable
,Cache
- Direct Known Subclasses:
CacheLRU
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
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) GenericCacheEntry[]
(package private) int
static final int
The default capacity to be used by the GenericCache subclasses provided with this package.private static final long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
addElement
(Object key, Object value) Adds an element to the cache.final int
capacity()
Returns the maximum number of elements that can be cached at one time.getElement
(Object key) Gets an element from the cache.final boolean
isFull()
Checks if the cache is full.keys()
Gets the cache objects names.final int
size()
Returns the number of elements in the cache, not to be confused with thecapacity()
which returns the number of elements that can be held in the cache at one time.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
DEFAULT_CAPACITY
public static final int DEFAULT_CAPACITYThe default capacity to be used by the GenericCache subclasses provided with this package. Its value is 20.- See Also:
-
_numEntries
int _numEntries -
_cache
GenericCacheEntry[] _cache -
_table
-
-
Constructor Details
-
GenericCache
GenericCache(int cap) The primary constructor for GenericCache. It has default access so it will only be used within the package. It initializes _table to a Hashtable of capacity equal to the capacity argument, _cache to an array of size equal to the capacity argument, and _numEntries to 0.- Parameters:
cap
- The maximum capacity of the cache.
-
-
Method Details
-
addElement
Description copied from interface:Cache
Adds an element to the cache.- Specified by:
addElement
in interfaceCache
- Parameters:
key
- Keyvalue
- Value
-
getElement
Description copied from interface:Cache
Gets an element from the cache.- Specified by:
getElement
in interfaceCache
- Parameters:
key
- Key- Returns:
- Element value
-
keys
Gets the cache objects names.- Returns:
- Object names (keys)
-
size
public final int size()Returns the number of elements in the cache, not to be confused with thecapacity()
which returns the number of elements that can be held in the cache at one time. -
capacity
public final int capacity()Returns the maximum number of elements that can be cached at one time. -
isFull
public final boolean isFull()Checks if the cache is full.- Returns:
true
if the cache is full,false
otherwise
-