Package org.apache.openjpa.datacache

Interface CacheStatistics

  • All Superinterfaces:
    java.io.Serializable
    All Known Subinterfaces:
    CacheStatisticsSPI
    All Known Implementing Classes:
    CacheStatisticsImpl
    public interface CacheStatistics
extends java.io.Serializable
    Counts number of read/write requests and hit ratio for a cache in total and per-class basis. All methods with Class as input argument treats null as java.lang.Object. All per-class statistics depends on determining the runtime type of the instance being cached. If it is not possible to determine the runtime type from the given context, the statistics is registered under generic java.lang.Object.
    Since:
    1.3.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> classNames()
      Returns the types that are known to this cache being tracked.
      long getHitCount()
      Gets number of total read requests that has been found in cache since last reset.
      long getHitCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getHitCount(String c)
      long getHitCount​(java.lang.String c)
      Gets number of total read requests that has been found in cache for the given class since last reset.
      long getReadCount()
      Gets number of total read requests since last reset.
      long getReadCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getReadCount(String c)
      long getReadCount​(java.lang.String c)
      Gets number of total read requests for the given class since last reset.
      long getTotalHitCount()
      Gets number of total read requests that has been found in cache since start.
      long getTotalHitCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getTotalHitCount(String c)
      long getTotalHitCount​(java.lang.String c)
      Gets number of total read requests that has been found in cache for the given class since start.
      long getTotalReadCount()
      Gets number of total read requests since start.
      long getTotalReadCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getTotalReadCount(String c)
      long getTotalReadCount​(java.lang.String c)
      Gets number of total read requests for the given class since start.
      long getTotalWriteCount()
      Gets number of total write requests since start.
      long getTotalWriteCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getTotalWriteCount(String c)
      long getTotalWriteCount​(java.lang.String c)
      Gets number of total write requests for the given class since start.
      long getWriteCount()
      Gets number of total write requests since last reset.
      long getWriteCount​(java.lang.Class<?> cls)
      Deprecated.
      - should use getWriteCount(String c)
      long getWriteCount​(java.lang.String c)
      Gets number of total write requests for the given class since last reset.
      boolean isEnabled()
      Returns whether or not statistics will be collected.
      void reset()
      Clears all accumulated statistics.
      java.util.Date since()
      Gets the time of last reset.
      java.util.Date start()
      Gets the time of start.
      java.util.Map<java.lang.String,​long[]> toMap()  

    • Method Detail

      • getReadCount

        long getReadCount()
        Gets number of total read requests since last reset.

      • getHitCount

        long getHitCount()
        Gets number of total read requests that has been found in cache since last reset.

      • getWriteCount

        long getWriteCount()
        Gets number of total write requests since last reset.

      • getTotalReadCount

        long getTotalReadCount()
        Gets number of total read requests since start.

      • getTotalHitCount

        long getTotalHitCount()
        Gets number of total read requests that has been found in cache since start.

      • getTotalWriteCount

        long getTotalWriteCount()
        Gets number of total write requests since start.

      • getReadCount

        @Deprecated
long getReadCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getReadCount(String c)
        Gets number of total read requests for the given class since last reset.

      • getReadCount

        long getReadCount​(java.lang.String c)
        Gets number of total read requests for the given class since last reset.

      • getHitCount

        @Deprecated
long getHitCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getHitCount(String c)
        Gets number of total read requests that has been found in cache for the given class since last reset.

      • getHitCount

        long getHitCount​(java.lang.String c)
        Gets number of total read requests that has been found in cache for the given class since last reset.

      • getWriteCount

        @Deprecated
long getWriteCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getWriteCount(String c)
        Gets number of total write requests for the given class since last reset.

      • getWriteCount

        long getWriteCount​(java.lang.String c)
        Gets number of total write requests for the given class since last reset.

      • getTotalReadCount

        @Deprecated
long getTotalReadCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getTotalReadCount(String c)
        Gets number of total read requests for the given class since start.

      • getTotalReadCount

        long getTotalReadCount​(java.lang.String c)
        Gets number of total read requests for the given class since start.

      • getTotalHitCount

        long getTotalHitCount​(java.lang.String c)
        Gets number of total read requests that has been found in cache for the given class since start.

      • getTotalHitCount

        @Deprecated
long getTotalHitCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getTotalHitCount(String c)
        Gets number of total read requests that has been found in cache for the given class since start.

      • getTotalWriteCount

        long getTotalWriteCount​(java.lang.String c)
        Gets number of total write requests for the given class since start.

      • getTotalWriteCount

        @Deprecated
long getTotalWriteCount​(java.lang.Class<?> cls)
        Deprecated.
        - should use getTotalWriteCount(String c)
        Gets number of total write requests for the given class since start.

      • since

        java.util.Date since()
        Gets the time of last reset.

      • start

        java.util.Date start()
        Gets the time of start.

      • reset

        void reset()
        Clears all accumulated statistics.

      • isEnabled

        boolean isEnabled()
        Returns whether or not statistics will be collected.

      • classNames

        java.util.Set<java.lang.String> classNames()
        Returns the types that are known to this cache being tracked.

      • toMap

        java.util.Map<java.lang.String,​long[]> toMap()