org.javamoney.moneta.function

Class MonetarySummaryStatistics

java.lang.Object

org.javamoney.moneta.function.MonetarySummaryStatistics

public class MonetarySummaryStatistics
extends Object

A state object for collecting statistics such as count, min, max, sum, and average.

Author:

otaviojava, Anatole Tresch

Method Summary

Modifier and Type	Method and Description
void	accept(javax.money.MonetaryAmount amount) Records another value into the summary information.
MonetarySummaryStatistics	combine(MonetarySummaryStatistics summaryStatistics) Combines the state of another MonetarySummaryStatistics into this one.
boolean	equals(Object obj) will equals when the currency utils were equals
javax.money.MonetaryAmount	getAverage() Get the mean average of all amounts added.
long	getCount() Get the number of items added to this summary instance.
javax.money.MonetaryAmount	getMax() Get the maximal amount found within this summary.
javax.money.MonetaryAmount	getMin() Get the minimal amount found within this summary.
javax.money.MonetaryAmount	getSum() Get the sum of all amounts within this summary.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

accept

public void accept(javax.money.MonetaryAmount amount)

Records another value into the summary information.

Parameters:

amount - the input amount value to be addeed, not null.

combine

public MonetarySummaryStatistics combine(MonetarySummaryStatistics summaryStatistics)

Combines the state of another MonetarySummaryStatistics into this one.

Parameters:

summaryStatistics - another MonetarySummaryStatistics, not null.

getCount

public long getCount()

Get the number of items added to this summary instance.

Returns:

the number of summarized items, >= 0.

getMin

public javax.money.MonetaryAmount getMin()

Get the minimal amount found within this summary.

Returns:

the minimal amount, or null if no amount was added to this summary instance.

getMax

public javax.money.MonetaryAmount getMax()

Get the maximal amount found within this summary.

Returns:

the minimal amount, or null if no amount was added to this summary instance.

getSum

public javax.money.MonetaryAmount getSum()

Get the sum of all amounts within this summary.

Returns:

the total amount, or null if no amount was added to this summary instance.

getAverage

public javax.money.MonetaryAmount getAverage()

Get the mean average of all amounts added.

Returns:

the mean average amount, or null if no amount was added to this summary instance.

equals

public boolean equals(Object obj)

will equals when the currency utils were equals

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object