Interface Cache

  • All Known Implementing Classes:
    CacheLRU, GenericCache

    public interface Cache
    An interface defining the basic functions of a cache.
    Since:
    1.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addElement​(java.lang.Object key, java.lang.Object value)
      Adds an element to the cache.
      int capacity()
      Returns the maximum number of elements that can be cached at one time.
      java.lang.Object getElement​(java.lang.Object key)
      Gets an element from the cache.
      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.
    • Method Detail

      • addElement

        void addElement​(java.lang.Object key,
                        java.lang.Object value)
        Adds an element to the cache.
        Parameters:
        key - Key
        value - Value
      • getElement

        java.lang.Object getElement​(java.lang.Object key)
        Gets an element from the cache.
        Parameters:
        key - Key
        Returns:
        Element value
      • size

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

        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.