net.anotheria.moskito.core.producers

Interface IStats

All Known Subinterfaces:

ICustomDecoratorStats

All Known Implementing Classes:

AbstractMemoryPoolStats, AbstractStats, ActionStats, CacheStats, CounterStats, ErrorStats, FilterStats, GCStats, GenericCounterStats, GenericStats, GlobalRequestProcessorStats, GuestBasicPremiumStats, MaleFemaleStats, MBeanStats, MemoryPoolStats, MemoryStats, OSStats, PageInBrowserStats, QueueStats, QueuingSystemStats, RequestOrientedStats, RuntimeStats, ServiceStats, ServletStats, SessionCountStats, StorageStats, ThreadCountStats, ThreadStateStats, VirtualMemoryPoolStats

public interface IStats

IStats is the internal representation of a statistical value set. Its multidimensional since it supports simultaneous values for multiple intervals. It can contain multiple StatValues of different types (long, int, double etc). IStats are 'produced' or gathered by the IStatsProducer. Typical IStats are ServiceStats, CacheStats, MemoryStats etc.

Author:

lrosenberg

Method Summary

Modifier and Type	Method and Description
CallExecution	createCallExecution()
void	destroy() Called when this stats object is removed from the system.
java.util.List<java.lang.String>	getAvailableValueNames() Returns the names of all contained stats.
java.lang.String	getName() This method returns the name of this set of statistical values.
java.lang.String	getValueByNameAsString(java.lang.String valueName, java.lang.String intervalName, TimeUnit timeUnit)
boolean	isEmpty(java.lang.String intervalName) Returns true if this stat object didn't record anything of interest in a given interval.
java.lang.String	toStatsString() This method creates a human-readable textual representation of all statistical values in all intervals.
java.lang.String	toStatsString(java.lang.String aIntervalName) This method creates a human-readable textual representation of all statistical values in the given interval.
java.lang.String	toStatsString(java.lang.String aIntervalName, TimeUnit unit) This method creates a human-readable textual representation of all statistical values in the given interval.
java.lang.String	toStatsString(TimeUnit unit) This method creates a human-readable textual representation of all statistical values in all intervals.

Method Detail

toStatsString

java.lang.String toStatsString()

This method creates a human-readable textual representation of all statistical values in all intervals.

Returns:

the formatted text output

toStatsString

java.lang.String toStatsString(java.lang.String aIntervalName)

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

Parameters:

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

Returns:

the formatted text output

toStatsString

java.lang.String toStatsString(TimeUnit unit)

This method creates a human-readable textual representation of all statistical values in all intervals.

Returns:

the formatted text output

toStatsString

java.lang.String toStatsString(java.lang.String aIntervalName,
                               TimeUnit unit)

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

Parameters:

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

Returns:

the formatted text output

getName

java.lang.String getName()

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

Returns:

the name

createCallExecution

CallExecution createCallExecution()

getValueByNameAsString

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

getAvailableValueNames

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

Returns the names of all contained stats.

Returns:

isEmpty

boolean isEmpty(java.lang.String intervalName)

Returns true if this stat object didn't record anything of interest in a given interval. This is useful to reduce garbage.

Returns:

destroy

void destroy()

Called when this stats object is removed from the system. Usually stat objects reside in the system forever, however for producers that register and unregister stats objects (for example RollingOnDemandStatsProducer) it is useful to destroy the objects. Upon this call the stats object should clean up any references it still holds and unregister itself from events.