Java Doc for StopWatch.java in  » Library » Apache-common-lang » org » apache » commons » lang » time » Java Source Code / Java DocumentationJava Source Code and Java Documentation

StopWatch provides a convenient API for timings.

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

• StopWatch.split() the watch to get the time whilst the watch continues in the background. StopWatch.unsplit() will remove the effect of the split. At this point, these three options are available again.
• StopWatch.suspend() the watch to pause it. StopWatch.resume() allows the watch to continue. Any time between the suspend and resume will not be counted in the total. At this point, these three options are available again.
• StopWatch.stop() the watch to complete the timing session.

It is intended that the output methods StopWatch.toString() and StopWatch.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()

Get the split time on the stopwatch.

This is the time between start and latest split.

Resets the stopwatch.

Resume the stopwatch after a suspend.

This method resumes the watch after it was suspended.

Split the time.

This method sets the stop time of the watch to allow a time to be extracted.

Suspend the stopwatch for later resumption.

This method suspends the watch until it is resumed.

Remove a split.

This method clears the stop time.

Constructor.

Get the split time on the stopwatch.

This is the time between start and latest split.

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.

Resets the stopwatch. Stops it if need be.

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

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 the time.

This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling StopWatch.unsplit() to continue the timing from the original start point.

Start the stopwatch.

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

Stop the stopwatch.

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

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.

Gets a summary of the split time that the stopwatch recorded as a string.

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

Gets a summary of the time that the stopwatch recorded as a string.

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

Remove a split.

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