CacheMonitorState (Jetspeed-2 Core API 2.3.1 API)

```
public interface CacheMonitorState
```
Individual cache information and state to provide to Jetspeed Cache Monitor

Version:

$Id: CacheMonitorState.java 773303 2009-05-10 03:34:13Z taylor $

Author:

David Sean Taylor

Method Summary

Methods
Modifier and Type	Method and Description
`float`	`getAverageGetTime()`
`long`	`getCacheHits()`
`long`	`getCacheMisses()`
`String`	`getCacheName()`
`long`	`getDiskStoreSize()`
`long`	`getEvictionCount()`
`long`	`getInMemoryHits()`
`long`	`getInMemorySize()`
`long`	`getMaxElementsInMemory()`
`long`	`getMaxElementsOnDisk()`
`long`	`getMemoryStoreSize()`
`long`	`getObjectCount()`
`long`	`getOnDiskHits()`
`long`	`getSize()`
`long`	`getTimeToIdle()`
`long`	`getTimeToLive()`

- Method Detail
  - getCacheName
```
String getCacheName()
```
    Returns:
    the name of the cache
  - getMemoryStoreSize
```
long getMemoryStoreSize()
```
    Returns:
    the number of elements in the memory cache
  - getInMemorySize
```
long getInMemorySize()
```
    Returns:
    the size of the memory store for this cache
  - getSize
```
long getSize()
```
    Returns:
    the entire size of the cache including the number of elements in the memory store plus the number of elements in the disk store
  - getDiskStoreSize
```
long getDiskStoreSize()
```
    Returns:
    the number of elements in the disk store
  - getAverageGetTime
```
float getAverageGetTime()
```
    Returns:
    the average time to retrieve a cache element in milliseconds
  - getCacheHits
```
long getCacheHits()
```
    Returns:
    the number of times a requested item was found in the cache.
  - getCacheMisses
```
long getCacheMisses()
```
    Returns:
    the number of times a requested element was not found in the cache
  - getEvictionCount
```
long getEvictionCount()
```
    Returns:
    the number of cache evictions, since the cache was created, or statistics were cleared
  - getInMemoryHits
```
long getInMemoryHits()
```
    Returns:
    the number of times a requested item was found in memory
  - getObjectCount
```
long getObjectCount()
```
    Returns:
    gets the number of elements stored in the cache. Caclulating this can be expensive. Accordingly, this method will return three different values, depending on the statistics accuracy setting
  - getOnDiskHits
```
long getOnDiskHits()
```
    Returns:
    the number of times a requested element was not found in the cache
  - getMaxElementsInMemory
```
long getMaxElementsInMemory()
```
    Returns:
    get configured maximum elements in memory
  - getMaxElementsOnDisk
```
long getMaxElementsOnDisk()
```
    Returns:
    get configured maximum elements on disk
  - getTimeToIdle
```
long getTimeToIdle()
```
    Returns:
    get configured time to idle in seconds before expiring
  - getTimeToLive
```
long getTimeToLive()
```
    Returns:
    get configured time to live in seconds before expiring

Interface CacheMonitorState

Method Summary

Method Detail

getCacheName

getMemoryStoreSize

getInMemorySize

getSize

getDiskStoreSize

getAverageGetTime

getCacheHits

getCacheMisses

getEvictionCount

getInMemoryHits

getObjectCount

getOnDiskHits

getMaxElementsInMemory

getMaxElementsOnDisk

getTimeToIdle

getTimeToLive