Class GenericCache

java.lang.Object
org.apache.oro.util.GenericCache
All Implemented Interfaces:
Serializable, Cache
Direct Known Subclasses:
CacheLRU
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
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_CAPACITY
    The default capacity to be used by the GenericCache subclasses provided with this package.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract 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.
    Object
    getElement(Object key)
    Gets an element from the cache.
    final boolean
    isFull()
    Checks if the cache is full.
    final Iterator<Object>
    keys()
    Gets the cache objects names.
    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.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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.
      See Also:

  • Method Details

    • addElement

      public abstract void addElement(Object key, Object value)
      Description copied from interface: Cache
      Adds an element to the cache.
      Specified by:
      addElement in interface Cache
      Parameters:
      key - Key
      value - Value

    • getElement

      public Object getElement(Object key)
      Description copied from interface: Cache
      Gets an element from the cache.
      Specified by:
      getElement in interface Cache
      Parameters:
      key - Key
      Returns:
      Element value

    • keys

      public final Iterator<Object> 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 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).

    • 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.

    • isFull

      public final boolean isFull()
      Checks if the cache is full.
      Returns:
      true if the cache is full, false otherwise