net.anotheria.moskito.core.predefined

Class CacheStats

java.lang.Object

net.anotheria.moskito.core.producers.AbstractStats

net.anotheria.moskito.core.predefined.CacheStats

All Implemented Interfaces:

IStats, StatsMXBean

public class CacheStats
extends AbstractStats

Stats for (read) caches.

Author:

lrosenberg

Field Summary

Fields inherited from class net.anotheria.moskito.core.producers.AbstractStats

MB

Constructor Summary

Constructors

Constructor and Description
CacheStats() Creates a new 'unnamed' cache stats object with default intervals.
CacheStats(java.lang.String aName, Interval[] selectedIntervals) Creates a new cachestats object.

Method Summary

Modifier and Type	Method and Description
void	addCacheFull() Adds a cache full condition.
void	addDelete() Adds an object removal.
void	addExpired() Adds an expiration event.
void	addFiltered() Adds a filtered object.
void	addGarbageCollected() Adds a garbage collected object.
void	addHit() Adds a new cache-hit.
void	addHitRequest() Adds a request that was a hit.
void	addRequest() Adds a new cache request.
void	addRollover() Adds a rollover.
void	addWrite() Adds a write (new object) in the cache.
java.util.List<java.lang.String>	getAvailableValueNames() Returns the names of all contained stats.
long	getCacheFullCount(java.lang.String intervalName) Returns the number of cache fulls in the specified interval.
long	getDeletes(java.lang.String intervalName) Returns the number of object deletion in a given interval.
long	getExpired(java.lang.String intervalName) Return number of expired objects.
double	getFillRatio(java.lang.String intervalName) Returns the fill ration of the cache in a given interval.
long	getFiltered(java.lang.String intervalName) Returns the number of filtered objects in a given interval.
long	getGarbageCollected(java.lang.String intervalName) Returns number of garbage collected objects in the given interval.
double	getHitRatio(java.lang.String intervalName) Returns this caches hit ratio.
long	getHits(java.lang.String intervalName) Returns the number of hits in a given interval.
java.lang.String	getName() This method returns the name of this set of statistical values.
long	getRequests(java.lang.String intervalName) Returns the number of requests in a given interval.
long	getRolloverCount(java.lang.String intervalName) Returns the number of cache rollovers in a given interval.
java.lang.String	getValueByNameAsString(java.lang.String valueName, java.lang.String intervalName, TimeUnit timeUnit)
long	getWrites(java.lang.String intervalName) Returns the number of writes (new objects) in the cache int the given interval.
java.lang.String	toStatsString(java.lang.String intervalName, TimeUnit timeUnit) This method creates a human-readable textual representation of all statistical values in the given interval.

Methods inherited from class net.anotheria.moskito.core.producers.AbstractStats

addStatValues, createCallExecution, destroy, isEmpty, toStatsString, toStatsString, toStatsString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheStats

public CacheStats()

Creates a new 'unnamed' cache stats object with default intervals.

CacheStats

public CacheStats(java.lang.String aName,
                  Interval[] selectedIntervals)

Creates a new cachestats object.

Parameters:

aName -

selectedIntervals -

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IStats

This method returns the name of this set of statistical values.

Specified by:

getName in interface IStats

Overrides:

getName in class AbstractStats

Returns:

the name

getHitRatio

public double getHitRatio(java.lang.String intervalName)

Returns this caches hit ratio.

Parameters:

intervalName - the name of the target interval.

Returns:

addRequest

public void addRequest()

Adds a new cache request.

getRequests

public long getRequests(java.lang.String intervalName)

Returns the number of requests in a given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addHit

public void addHit()

Adds a new cache-hit.

getHits

public long getHits(java.lang.String intervalName)

Returns the number of hits in a given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addHitRequest

public void addHitRequest()

Adds a request that was a hit. Its the same as calling addRequest();addHit().

addWrite

public void addWrite()

Adds a write (new object) in the cache.

getWrites

public long getWrites(java.lang.String intervalName)

Returns the number of writes (new objects) in the cache int the given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addDelete

public void addDelete()

Adds an object removal.

getDeletes

public long getDeletes(java.lang.String intervalName)

Returns the number of object deletion in a given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addRollover

public void addRollover()

Adds a rollover. This is only useful for fixed size caches that support rollover.

addCacheFull

public void addCacheFull()

Adds a cache full condition. Only for caches with limited size and without rollover.

getCacheFullCount

public long getCacheFullCount(java.lang.String intervalName)

Returns the number of cache fulls in the specified interval.

Parameters:

intervalName - the name of the target interval.

Returns:

getRolloverCount

public long getRolloverCount(java.lang.String intervalName)

Returns the number of cache rollovers in a given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addGarbageCollected

public void addGarbageCollected()

Adds a garbage collected object. This is only supported by SoftReference caches.

getGarbageCollected

public long getGarbageCollected(java.lang.String intervalName)

Returns number of garbage collected objects in the given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addFiltered

public void addFiltered()

Adds a filtered object. Only supported by caches that can filter objects.

getFiltered

public long getFiltered(java.lang.String intervalName)

Returns the number of filtered objects in a given interval.

Parameters:

intervalName - the name of the target interval.

Returns:

addExpired

public void addExpired()

Adds an expiration event. Only supported by ExpiringCaches.

getExpired

public long getExpired(java.lang.String intervalName)

Return number of expired objects. Please note this value represents the amount of expired objects actually reported by the cache. If the cache is calculating expiration on request, the value will only represent the amount of detect expired elements.

Parameters:

intervalName - the name of the target interval.

Returns:

returns the number of expired objects in the cache in the given interval.

getFillRatio

public double getFillRatio(java.lang.String intervalName)

Returns the fill ration of the cache in a given interval. Warning: currently not supported by any cache!

Parameters:

intervalName - the name of the target interval.

Returns:

getAvailableValueNames

public java.util.List<java.lang.String> getAvailableValueNames()

Description copied from interface: IStats

Returns the names of all contained stats.

Specified by:

getAvailableValueNames in interface IStats

Specified by:

getAvailableValueNames in interface StatsMXBean

Overrides:

getAvailableValueNames in class AbstractStats

Returns:

toStatsString

public java.lang.String toStatsString(java.lang.String intervalName,
                                      TimeUnit timeUnit)

Description copied from interface: IStats

This method creates a human-readable textual representation of all statistical values in the given interval.

Parameters:

intervalName - the name of the interval or null for all intervals

Returns:

the formatted text output

getValueByNameAsString

public java.lang.String getValueByNameAsString(java.lang.String valueName,
                                               java.lang.String intervalName,
                                               TimeUnit timeUnit)

Specified by:

getValueByNameAsString in interface IStats

Overrides:

getValueByNameAsString in class AbstractStats