net.digitaltsunami.tmeter

Class TimerBasicStatistics

java.lang.Object

net.digitaltsunami.tmeter.TimerBasicStatistics

All Implemented Interfaces:

Comparable<TimerBasicStatistics>

public class TimerBasicStatistics
extends Object
implements Comparable<TimerBasicStatistics>

Maintains basic statistics for a given task. The maintained statistics are basic so that it does not have to maintain a list of the elapsed values.

Currently tracked statistics are:

• Count
• Min Elapsed Time
• Max Elapsed Time
• Total Elapsed Time
• Average Elapsed Time

Author:

dhagberg

Constructor Summary

Constructors

Constructor and Description
TimerBasicStatistics(String taskName) Create an empty statistics instance for the task.
TimerBasicStatistics(Timer timer) Create a statistics instance and initialize with the values from the Timer provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTimer(Timer timer) Add the results of a timer to the currently tracked statistics for this timer.
int	compareTo(TimerBasicStatistics o)
boolean	equals(Object obj)
double	getAverageElapsed(TimeUnit timeUnit) Return the average elapsed time recorded for this task.
double	getAverageElapsedNanos() Return the average elapsed time recorded for this task in nanoseconds.
int	getCount() Return the number of times this instance has been updated with timer values.
long	getMaxElapsed(TimeUnit timeUnit) Return the maximum time recorded for this task.
long	getMaxElapsedNanos() Return the maximum number of elapsed nanoseconds recorded for this task.
long	getMinElapsed(TimeUnit timeUnit) Return the minimum time recorded for this task.
long	getMinElapsedNanos() Return the minimum number of elapsed nanoseconds recorded for this task.
TimerBasicStatistics	getSnapshot() Creates a snapshot of the instance and returns as a new instance.
double	getStdDevElapsed(TimeUnit timeUnit) Return the standard deviation of elapsed times recorded for this task.
double	getStdDevElapsedNanos() Return the standard deviation of elapsed times recorded for this task in nanoseconds.
String	getTaskName() Return the task name for which the statistics are being tracked.
long	getTotalElapsed(TimeUnit timeUnit) Return the accumulated time recorded for this task.
long	getTotalElapsedNanos() Return the accumulated number of elapsed nanoseconds recorded for this task.
double	getVarianceElapsed(TimeUnit timeUnit) Return the variance of elapsed times recorded for this task.
double	getVarianceElapsedNanos() Return the variance of elapsed times recorded for this task in nanoseconds.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimerBasicStatistics

public TimerBasicStatistics(String taskName)

Create an empty statistics instance for the task.

Parameters:

taskName -

TimerBasicStatistics

public TimerBasicStatistics(Timer timer)

Create a statistics instance and initialize with the values from the Timer provided.

Parameters:

timer -

Method Detail

addTimer

public void addTimer(Timer timer)

Add the results of a timer to the currently tracked statistics for this timer.

Parameters:

timer -

Throws:

IllegalArgumentException - if the Timer.getTaskName() does not match taskName

getTaskName

public String getTaskName()

Return the task name for which the statistics are being tracked.

Returns:

getCount

public int getCount()

Return the number of times this instance has been updated with timer values.

Returns:

getTotalElapsedNanos

public long getTotalElapsedNanos()

Return the accumulated number of elapsed nanoseconds recorded for this task.

Returns:

getTotalElapsed

public long getTotalElapsed(TimeUnit timeUnit)

Return the accumulated time recorded for this task. The time will be returned in the TimeUnit provided.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

getMinElapsedNanos

public long getMinElapsedNanos()

Return the minimum number of elapsed nanoseconds recorded for this task.

Returns:

Minimum elapsed time in nanoseconds for this this task or Long.MAX_VALUE if no timers have yet been recorded.

getMinElapsed

public long getMinElapsed(TimeUnit timeUnit)

Return the minimum time recorded for this task. The time will be returned in the TimeUnit provided.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

getMaxElapsedNanos

public long getMaxElapsedNanos()

Return the maximum number of elapsed nanoseconds recorded for this task.

Returns:

Maximum elapsed time in nanoseconds for this this task or Long.MIN_VALUE if no timers have yet been recorded.

getMaxElapsed

public long getMaxElapsed(TimeUnit timeUnit)

Return the maximum time recorded for this task. The time will be returned in the TimeUnit provided.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

getAverageElapsedNanos

public double getAverageElapsedNanos()

Return the average elapsed time recorded for this task in nanoseconds.

Returns:

average elapsed time in nanoseconds.

getAverageElapsed

public double getAverageElapsed(TimeUnit timeUnit)

Return the average elapsed time recorded for this task. The time will be returned in the TimeUnit provided.

May lose precision as fractional portion of mean will be truncated in conversion method.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

average elapsed time in TimeUnit provided.

getVarianceElapsedNanos

public double getVarianceElapsedNanos()

Return the variance of elapsed times recorded for this task in nanoseconds.

Returns:

variance of elapsed time in nanoseconds.

getVarianceElapsed

public double getVarianceElapsed(TimeUnit timeUnit)

Return the variance of elapsed times recorded for this task. The time will be returned in the TimeUnit provided.

May lose precision as fractional portion of variance will be truncated in conversion method.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

standard deviation of elapsed times in TimeUnit provided.

getStdDevElapsedNanos

public double getStdDevElapsedNanos()

Return the standard deviation of elapsed times recorded for this task in nanoseconds.

Returns:

standard deviation of elapsed time in nanoseconds.

getStdDevElapsed

public double getStdDevElapsed(TimeUnit timeUnit)

Return the standard deviation of elapsed times recorded for this task. The time will be returned in the TimeUnit provided.

May lose precision as fractional portion of variance will be truncated in conversion method.

Parameters:

timeUnit - Desired time unit for returned value.

Returns:

standard deviation of elapsed times in TimeUnit provided.

getSnapshot

public TimerBasicStatistics getSnapshot()

Creates a snapshot of the instance and returns as a new instance. These values will not be updated as more timers are processed.

Returns:

new instance of TimerBasicStatistics that is a snapshot at the time returned.

compareTo

public int compareTo(TimerBasicStatistics o)

Specified by:

compareTo in interface Comparable<TimerBasicStatistics>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object