Package org.springframework.util
Class StopWatch
- java.lang.Object
- org.springframework.util.StopWatch
public class StopWatch extends Object
Simple stop watch, allowing for timing of a number of tasks, exposing total running time and running time for each named task.Conceals use of
System.currentTimeMillis()
, improving the readability of application code and reducing the likelihood of calculation errors.Note that this object is not designed to be thread-safe and does not use synchronization.
This class is normally used to verify performance during proof-of-concepts and in development, rather than as part of production applications.
- Since:
- May 2, 2001
- Author:
- Rod Johnson, Juergen Hoeller, Sam Brannen
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StopWatch.TaskInfo
Inner class to hold data about one task executed within the stop watch.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
currentTaskName()
Return the name of the currently running task, if any.String
getId()
Return the id of this stop watch, as specified on construction.StopWatch.TaskInfo
getLastTaskInfo()
Return the last task as a TaskInfo object.String
getLastTaskName()
Return the name of the last task.long
getLastTaskTimeMillis()
Return the time taken by the last task.int
getTaskCount()
Return the number of tasks timed.StopWatch.TaskInfo[]
getTaskInfo()
Return an array of the data for tasks performed.long
getTotalTimeMillis()
Return the total time in milliseconds for all tasks.double
getTotalTimeSeconds()
Return the total time in seconds for all tasks.boolean
isRunning()
Return whether the stop watch is currently running.String
prettyPrint()
Return a string with a table describing all tasks performed.void
setKeepTaskList(boolean keepTaskList)
Determine whether the TaskInfo array is built over time.String
shortSummary()
Return a short description of the total running time.void
start()
Start an unnamed task.void
start(String taskName)
Start a named task.void
stop()
Stop the current task.String
toString()
Return an informative string describing all tasks performed For custom reporting, callgetTaskInfo()
and use the task info directly.
Constructor Detail
StopWatch
public StopWatch()
Construct a new stop watch. Does not start any task.
Method Detail
getId
public String getId()
Return the id of this stop watch, as specified on construction.- Returns:
- the id (empty String by default)
- Since:
- 4.2.2
- See Also:
StopWatch(String)
setKeepTaskList
public void setKeepTaskList(boolean keepTaskList)
Determine whether the TaskInfo array is built over time. Set this to "false" when using a StopWatch for millions of intervals, or the task info structure will consume excessive memory. Default is "true".
start
public void start() throws IllegalStateException
Start an unnamed task. The results are undefined ifstop()
or timing methods are called without invoking this method.- Throws:
IllegalStateException
- See Also:
stop()
start
public void start(String taskName) throws IllegalStateException
Start a named task. The results are undefined ifstop()
or timing methods are called without invoking this method.- Parameters:
taskName
- the name of the task to start- Throws:
IllegalStateException
- See Also:
stop()
stop
public void stop() throws IllegalStateException
Stop the current task. The results are undefined if timing methods are called without invoking at least one pairstart()
/stop()
methods.- Throws:
IllegalStateException
- See Also:
start()
isRunning
public boolean isRunning()
Return whether the stop watch is currently running.- See Also:
currentTaskName()
currentTaskName
public String currentTaskName()
Return the name of the currently running task, if any.- Since:
- 4.2.2
- See Also:
isRunning()
getLastTaskTimeMillis
public long getLastTaskTimeMillis() throws IllegalStateException
Return the time taken by the last task.- Throws:
IllegalStateException
getLastTaskName
public String getLastTaskName() throws IllegalStateException
Return the name of the last task.- Throws:
IllegalStateException
getLastTaskInfo
public StopWatch.TaskInfo getLastTaskInfo() throws IllegalStateException
Return the last task as a TaskInfo object.- Throws:
IllegalStateException
getTotalTimeMillis
public long getTotalTimeMillis()
Return the total time in milliseconds for all tasks.
getTotalTimeSeconds
public double getTotalTimeSeconds()
Return the total time in seconds for all tasks.
getTaskCount
public int getTaskCount()
Return the number of tasks timed.
getTaskInfo
public StopWatch.TaskInfo[] getTaskInfo()
Return an array of the data for tasks performed.
shortSummary
public String shortSummary()
Return a short description of the total running time.
prettyPrint
public String prettyPrint()
Return a string with a table describing all tasks performed. For custom reporting, call getTaskInfo() and use the task info directly.