net.digitaltsunami.tmeter.action

Class TimerAction

java.lang.Object

net.digitaltsunami.tmeter.action.TimerAction

Direct Known Subclasses:

TimeRecorderAction, TimerStatsAction

public abstract class TimerAction
extends Object

Defines an interface for possibly more complex handling of timer instances.

Provides for a chain of actions to be defined that will execute upon the timer being stopped. Each action should be non-destructive in that it should not change the attributes of the Timer.

Author:

dhagberg

Field Summary

Fields

Modifier and Type	Field and Description
protected TimerAction	nextAction

Constructor Summary

Constructors

Constructor and Description
TimerAction()

Method Summary

Methods

Modifier and Type	Method and Description
TimerAction	addAction(TimerAction action) Add the provided action to the chain of actions to perform.
protected abstract void	processTimer(Timer timer) Perform any applicable processing specific to the actions.
protected void	reset() Perform any processing specific to the action for reset.
void	resetState() Drives the reset processing for all TimerAction instances.
void	timerComplete(Timer timer)

Methods inherited from class java.lang.Object

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

Field Detail

nextAction

protected TimerAction nextAction

Constructor Detail

TimerAction

public TimerAction()

Method Detail

addAction

public final TimerAction addAction(TimerAction action)

Add the provided action to the chain of actions to perform.

No guarantee as to the order in which the actions will be executed.

Parameters:

action - new action to add to chain. Cannot be null.

Returns:

provided action so that they may be chained without creating a local instance.

timerComplete

public final void timerComplete(Timer timer)

processTimer

protected abstract void processTimer(Timer timer)

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.

Parameters:

timer - an instance of a completed Timer.

reset

protected void reset()

Perform any processing specific to the action for reset. This method will be invoked to reset the state of the action and may indicate that a new timing run is starting.

Concrete classes should override this method if they accumulate timer data that is specific to a given run. The default is to do nothing.

resetState

public final void resetState()

Drives the reset processing for all TimerAction instances.