org.hsqldb.lib.StopWatch Maven / Gradle / Ivy
Show all versions of sqltool Show documentation
/* Copyright (c) 2001-2021, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.lib;
/**
* Provides the programatic analog of a physical stop watch.
*
* The watch can be started, stopped and zeroed and can be queried for
* elapsed running time. The watch accumulates elapsed time over starts
* and stops such that only the time actually spent running is recorded.
* If the watch is zeroed, then the accumulated time is discarded and
* the watch starts again with zero accumulated time.
*
* Nanosecond support added by fredt@users
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @version 2.6.0
* @since 1.7.2
*/
public class StopWatch {
/**
* The last time this object made the transition
* from stopped to running state, as reported
* by System.nanoTime().
*/
private long startTime;
private long lastStart;
/**
* The accumulated running time of this object since
* it was last zeroed.
*/
private long total;
/** Flags if this object is started or stopped. */
boolean running = false;
/** Creates, zeros, and starts a new StopWatch */
public StopWatch() {
this(true);
}
/**
* Creates, zeros, and starts a new StopWatch
*
* @param start boolean
*/
public StopWatch(boolean start) {
if (start) {
start();
}
}
/**
* Retrieves the accumulated milliseconds this object has spent running since
* it was last zeroed.
* @return the accumulated milliseconds this object has spent running since
* it was last zeroed.
*/
public long elapsedTime() {
if (running) {
return (total + System.nanoTime() - startTime) / 1000000;
} else {
return total / 1000000;
}
}
/**
* Retrieves the accumulated nanoseconds this object has spent running since
* it was last zeroed.
* @return the accumulated nanoseconds this object has spent running since
* it was last zeroed.
*/
public long elapsedNanos() {
if (running) {
return total + System.nanoTime() - startTime;
} else {
return total;
}
}
/**
* Retrieves the accumulated milliseconds this object has spent running since
* it was last started.
* @return the accumulated milliseconds this object has spent running since
* it was last started.
*/
public long currentElapsedTime() {
if (running) {
return (System.nanoTime() - startTime) / 1000000;
} else {
return 0;
}
}
/**
* Retrieves the accumulated nanoseconds this object has spent running since
* it was last started.
* @return the accumulated nanoseconds this object has spent running since
* it was last started.
*/
public long currentElapsedNanos() {
if (running) {
return (System.nanoTime() - startTime);
} else {
return 0;
}
}
/** Zeros accumulated running time and restarts this object. */
public void zero() {
total = 0;
start();
}
/**
* Ensures that this object is in the running state. If this object is not
* running, then the call has the effect of setting the startTime
* attribute to the current value of System.nanoTime() and setting
* the running attribute to true.
*/
public void start() {
startTime = System.nanoTime();
running = true;
}
/**
* Ensures that this object is in the stopped state. If this object is
* in the running state, then this has the effect of adding to the
* total attribute the elapsed time since the last transition
* from stopped to running state and sets the running attribute
* to false. If this object is not in the running state, this call has no
* effect.
*/
public void stop() {
if (running) {
total += System.nanoTime() - startTime;
running = false;
}
}
public void mark() {
stop();
start();
}
/**
* Retrieves prefix + " in " + elapsedTime() + " ms."
* @param prefix The string to use as a prefix
* @return prefix + " in " + elapsedTime() + " ms."
*/
public String elapsedTimeToMessage(String prefix) {
return prefix + " in " + elapsedTime() + " ms.";
}
/**
* Retrieves prefix + " in " + elapsedNanos() + " ns."
* @param prefix The string to use as a prefix
* @return prefix + " in " + elapsedNanos() + " ns."
*/
public String elapsedNanosToMessage(String prefix) {
return prefix + " in " + elapsedNanos() + " ns.";
}
/**
* Retrieves prefix + " in " + elapsedTime() + " ms."
* @param prefix The string to use as a prefix
* @return prefix + " in " + elapsedTime() + " ms."
*/
public String currentElapsedTimeToMessage(String prefix) {
return prefix + " in " + currentElapsedTime() + " ms.";
}
/**
* Retrieves prefix + " in " + elapsedTime() + " ns."
* @param prefix The string to use as a prefix
* @return prefix + " in " + elapsedTime() + " ns."
*/
public String currentElapsedNanosToMessage(String prefix) {
return prefix + " in " + currentElapsedNanos() + " ns.";
}
/**
* Retrieves the internal state of this object, as a String.
*
* The retrieved value is:
*
*
* super.toString() +
* "[running=" +
* running +
* ", startTime=" +
* startTime +
* ", total=" +
* total + "]";
*
* @return the state of this object, as a String
*/
public String toString() {
return super.toString() + "[running=" + running + ", startTime="
+ startTime + ", total=" + total + "]";
}
}