galileo.util

Class PerformanceTimer

java.lang.Object

galileo.util.PerformanceTimer

Direct Known Subclasses:

LoggedPerformanceTimer

public class PerformanceTimer
extends java.lang.Object

A very simple performance timer implementation using System.nanoTime(). This class can record multiple samples (time intervals), print them, etc.

Author:

malensek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PerformanceTimer.PerformanceSample Records information about an interval of time as a performance sample.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The name of this PerformanceTimer
protected java.util.Deque<PerformanceTimer.PerformanceSample>	samples Timer samples (time intervals)

Constructor Summary

Constructors

Constructor and Description
PerformanceTimer() Create a new nameless PerformanceTimer.
PerformanceTimer(java.lang.String name) Create a named PerformanceTimer.

Method Summary

Modifier and Type	Method and Description
double	getLastResult() Retrieves the last timing result, in miliseconds.
java.util.List<PerformanceTimer.PerformanceSample>	getSamples() Get all the samples recorded by this PerformanceTimer so far.
int	size() Retrieves the number of samples recorded by this PerformanceTimer instance.
void	start() Starts a time interval.
void	stop() Stops the currently-running time interval.
void	stopAndPrint() Stops the currently-running time interval and prints its duration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

The name of this PerformanceTimer

samples

protected java.util.Deque<PerformanceTimer.PerformanceSample> samples

Timer samples (time intervals)

Constructor Detail

PerformanceTimer

public PerformanceTimer()

Create a new nameless PerformanceTimer.

PerformanceTimer

public PerformanceTimer(java.lang.String name)

Create a named PerformanceTimer.

Method Detail

start

public void start()

Starts a time interval.

stop

public void stop()

Stops the currently-running time interval.

stopAndPrint

public void stopAndPrint()

Stops the currently-running time interval and prints its duration.

getSamples

public java.util.List<PerformanceTimer.PerformanceSample> getSamples()

Get all the samples recorded by this PerformanceTimer so far.

Returns:

PerformanceSamples recorded thus far.

getLastResult

public double getLastResult()

Retrieves the last timing result, in miliseconds. If no results have been recorded yet, this method will return 0.0.

size

public int size()

Retrieves the number of samples recorded by this PerformanceTimer instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object