net.digitaltsunami.tmeter.action

Class TimerStatsAction

java.lang.Object

net.digitaltsunami.tmeter.action.TimerAction

net.digitaltsunami.tmeter.action.TimerStatsAction

Direct Known Subclasses:

TimerStatsPublisherAction

public class TimerStatsAction
extends TimerAction

An implementation of TimerAction that provides basic statistics for all timers processed by this action. Basic statistics may be retrieved for a specific task or the entire set of tasks.

Author:

dhagberg

Field Summary

Fields inherited from class net.digitaltsunami.tmeter.action.TimerAction

nextAction

Constructor Summary

Constructors

Constructor and Description
TimerStatsAction()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<TimerBasicStatistics>	getAllTimerStatistics() Return a collection of live instances of TimerBasicStatistics for all tasks processed up to the point of invoking this method.
Collection<TimerBasicStatistics>	getAllTimerStatisticsSnapshot() Return a collection of snapshot instances of TimerBasicStatistics for all tasks processed up to the point of invoking this method.
TimerBasicStatistics	getTimerStatistics(String taskName) Return a live instance of TimerBasicStatistics for the provided task name.
TimerBasicStatistics	getTimerStatisticsSnapshot(String taskName) Return a snapshot instance of TimerBasicStatistics for the provided task name.
protected void	processTimer(Timer timer) Perform any applicable processing specific to the actions.
protected void	reset() Clears all accumulated statistics.

Methods inherited from class net.digitaltsunami.tmeter.action.TimerAction

addAction, resetState, timerComplete

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerStatsAction

public TimerStatsAction()

Method Detail

processTimer

protected void processTimer(Timer timer)

Description copied from class: TimerAction

Perform any applicable processing specific to the actions. This method will be invoked when a completed timer is submitted for processing.

Concrete classes must override this method in order to view the submitted timers.

Specified by:

processTimer in class TimerAction

Parameters:

timer - an instance of a completed Timer.

reset

protected void reset()

Clears all accumulated statistics.

Overrides:

reset in class TimerAction

See Also:

net.digitaltsunami.tmeter.TimeAction#reset()

getTimerStatistics

public TimerBasicStatistics getTimerStatistics(String taskName)

Return a live instance of TimerBasicStatistics for the provided task name. Internal values will be modified as this action processes timers.

Parameters:

taskName -

Returns:

Live instance of TimerBasicStatistics or null if that task has not yet been processed by this action.

getTimerStatisticsSnapshot

public TimerBasicStatistics getTimerStatisticsSnapshot(String taskName)

Return a snapshot instance of TimerBasicStatistics for the provided task name. Internal values will be not be modified as this action processes timers.

Parameters:

taskName -

Returns:

Snapshot of TimerBasicStatistics for task name or null if that task has not yet been processed by this action.

getAllTimerStatistics

public Collection<TimerBasicStatistics> getAllTimerStatistics()

Return a collection of live instances of TimerBasicStatistics for all tasks processed up to the point of invoking this method. Internal values will be modified as this action processes timers.

Returns:

Live instance of TimerBasicStatistics

getAllTimerStatisticsSnapshot

public Collection<TimerBasicStatistics> getAllTimerStatisticsSnapshot()

Return a collection of snapshot instances of TimerBasicStatistics for all tasks processed up to the point of invoking this method. Internal values will be modified as this action processes timers.

Returns:

Snapshot instance of TimerBasicStatistics