org.apache.commons.lang.time

Class StopWatch


public class StopWatch
extends Object

StopWatch provides a convenient API for timings.

To start the watch, call start(). At this point you can:

It is intended that the output methods toString() and getTime() should only be called after stop, split or suspend, however a suitable result will be returned at other points.

NOTE: As from v2.1, the methods protect against inappropriate calls. Thus you cannot now call stop before start, resume before suspend or unsplit before split.

1. split(), suspend(), or stop() cannot be invoked twice
2. unsplit() may only be called if the watch has been split()
3. resume() may only be called if the watch has been suspend()
4. start() cannot be called twice without calling reset()

Version:
$Id: StopWatch.java 189443 2005-06-07 21:28:07Z scolebourne $
Authors:
Henri Yandell
Stephen Colebourne
Since:
2.0

Constructor Summary

StopWatch()
Constructor.

Method Summary

long
getSplitTime()
Get the split time on the stopwatch.
long
getTime()
Get the time on the stopwatch.
void
reset()
Resets the stopwatch.
void
resume()
Resume the stopwatch after a suspend.
void
split()
Split the time.
void
start()
Start the stopwatch.
void
stop()
Stop the stopwatch.
void
suspend()
Suspend the stopwatch for later resumption.
String
toSplitString()
Gets a summary of the split time that the stopwatch recorded as a string.
String
toString()
Gets a summary of the time that the stopwatch recorded as a string.
void
unsplit()
Remove a split.

Constructor Details

StopWatch

public StopWatch()
Constructor.

Method Details

getSplitTime

public long getSplitTime()
Get the split time on the stopwatch.

This is the time between start and latest split.

Returns:
the split time in milliseconds
Since:
2.1

getTime

public long getTime()
Get the time on the stopwatch.

This is either the time between the start and the moment this method is called, or the amount of time between start and stop.

Returns:
the time in milliseconds

reset

public void reset()
Resets the stopwatch. Stops it if need be.

This method clears the internal values to allow the object to be reused.


resume

public void resume()
Resume the stopwatch after a suspend.

This method resumes the watch after it was suspended. The watch will not include time between the suspend and resume calls in the total time.


split

public void split()

start

public void start()
Start the stopwatch.

This method starts a new timing session, clearing any previous values.


stop

public void stop()
Stop the stopwatch.

This method ends a new timing session, allowing the time to be retrieved.


suspend

public void suspend()
Suspend the stopwatch for later resumption.

This method suspends the watch until it is resumed. The watch will not include time between the suspend and resume calls in the total time.


toSplitString

public String toSplitString()
Gets a summary of the split time that the stopwatch recorded as a string.

The format used is ISO8601-like, hours:minutes:seconds.milliseconds.

Returns:
the split time as a String
Since:
2.1

toString

public String toString()
Gets a summary of the time that the stopwatch recorded as a string.

The format used is ISO8601-like, hours:minutes:seconds.milliseconds.

Returns:
the time as a String

unsplit

public void unsplit()
Remove a split.

This method clears the stop time. The start time is unaffected, enabling timing from the original start point to continue.


Copyright © 2001-2005 - Apache Software Foundation