com.cloudhopper.commons.util

Class RunningAverage

java.lang.Object

com.cloudhopper.commons.util.RunningTotal

com.cloudhopper.commons.util.RunningAverage

public class RunningAverage
extends RunningTotal

Same as RunningTotal, but provides the average in its toString() method vs. the running total. Also, this provides the precision of the average (Double) to be set in the constructor that will be displayed in the toString() method.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
RunningAverage(int size, int precision)

Method Summary

Methods

Modifier and Type	Method and Description
String	toString() Returns a string representing the current running average.
String	toString(int temporaryPrecision) Returns a string representing the current running average, but will use the new precision rather than the one in the constructor.

Methods inherited from class com.cloudhopper.commons.util.RunningTotal

add, getAverage, getSize, getTotal

Methods inherited from class java.lang.Object

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

Constructor Detail

RunningAverage

public RunningAverage(int size,
              int precision)

Method Detail

toString

public String toString()

Returns a string representing the current running average. Will return a String of the double with the precision set in the constructor.
NOTE: Will use a readLock to get a thread-safe version.

Overrides:

toString in class RunningTotal

Returns:

toString

public String toString(int temporaryPrecision)

Returns a string representing the current running average, but will use the new precision rather than the one in the constructor.
NOTE: Will use a readLock to get a thread-safe version.

Returns: