public class StopWatch extends Object
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.
| Modifier and Type | Class and Description |
|---|---|
static class |
StopWatch.TaskInfo
Inner class to hold data about one task executed within the stop watch.
|
| Constructor and Description |
|---|
StopWatch()
Construct a new stop watch.
|
StopWatch(String id)
Construct a new stop watch with the given id.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
public StopWatch()
public StopWatch(String id)
id - identifier for this stop watch. Handy when we have output from multiple stop watches and need to
distinguish between them.public void setKeepTaskList(boolean keepTaskList)
public void start()
throws IllegalStateException
stop() or timing methods are called without invoking
this method.IllegalStateExceptionstop()public void start(String taskName) throws IllegalStateException
stop() or timing methods are called without invoking this
method.taskName - the name of the task to startIllegalStateExceptionstop()public void stop()
throws IllegalStateException
start() / stop() methods.IllegalStateExceptionstart()public boolean isRunning()
public long getLastTaskTimeMillis()
throws IllegalStateException
IllegalStateExceptionpublic long getTotalTimeMillis()
public double getTotalTimeSeconds()
public int getTaskCount()
public StopWatch.TaskInfo[] getTaskInfo()
public String shortSummary()
public String prettyPrint()
Copyright © 2008-2013. All Rights Reserved.