com.cloudhopper.commons.util

Class RunningTotal

java.lang.Object

com.cloudhopper.commons.util.RunningTotal

Direct Known Subclasses:

RunningAverage

public class RunningTotal
extends Object

Helps maintain a running total of X number of longs. Internally, this class maintains a list of X number of last long values. Adding a new value will evict the oldest value and the new running total will be recomputed. The toString() method will return the running total. If an average is preferred then please considering using the RunningAverage class. NOTE: This class is thread-safe since its typical multiple threads would want to call this class. Internally, this uses a ReadWrite lock to ensure efficient usage of this class. NOTE: This class internally stores the running total as a long -- avoid using large values, otherwise this class may cause an overflow.

Author:

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

Constructor Summary

Constructors

Constructor and Description
RunningTotal(int size)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long value) Adds a new value to our running total.
double	getAverage() Returns current average of our running total.
long	getSize() Returns current number of values in our running total.
long	getTotal() Returns current value of our running total.
String	toString() Returns a string representing the current running total.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunningTotal

public RunningTotal(int size)

Method Detail

add

public void add(long value)

Adds a new value to our running total. If the running total has already reached its max size, this method will evict the oldest value.
NOTE: This method will use a writeLock to ensure thread-safety.

Parameters:

value - The new long value to add

getSize

public long getSize()

Returns current number of values in our running total. This should always max out at the size value provided in our constructor.
NOTE: This method will use a readLock for thread-safety.

Returns:

Current number of values in our running total.

getTotal

public long getTotal()

Returns current value of our running total.
NOTE: This method will use a readLock for thread-safety.

Returns:

The current running total.

getAverage

public double getAverage()

Returns current average of our running total.
NOTE: This method will use a readLock for thread-safety.

Returns:

The current average of our running total.

toString

public String toString()

Returns a string representing the current running total. The same value the toString() value a Long class would return.
NOTE: Will use a readLock to get a thread-safe version.

Overrides:

toString in class Object

Returns: