MonetarySummaryStatistics (Moneta (JSR 354 RI) for Java 7 1.4.1 API)

All Known Implementing Classes:

DefaultMonetarySummaryStatistics
```
public interface MonetarySummaryStatistics
```
A state object for collecting statistics such as count, min, max, sum, and average.

Author:

otaviojava, Anatole Tresch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`accept(MonetaryAmount amount)` Records another value into the summary information.
`MonetarySummaryStatistics`	`combine(MonetarySummaryStatistics summaryStatistics)` Combines the state of another `MonetarySummaryStatistics` into this one.
`MonetaryAmount`	`getAverage()` Get the mean average of all amounts added.
`long`	`getCount()` Get the number of items added to this summary instance.
`CurrencyUnit`	`getCurrencyUnit()` the currency unit used in summary
`MonetaryAmount`	`getMax()` Get the maximal amount found within this summary.
`MonetaryAmount`	`getMin()` Get the minimal amount found within this summary.
`MonetaryAmount`	`getSum()` Get the sum of all amounts within this summary.
`boolean`	`isExchangeable()` return if is possible do exchange rate or not with the MonetarySummary
`MonetarySummaryStatistics`	`to(CurrencyUnit unit)` created the MonetarySummaryStatistics converted to `CurrencyUnit`

- Method Detail
  - accept
```
void accept(MonetaryAmount amount)
```
    Records another value into the summary information.
    
    Parameters:
    
    amount - the input amount value to be added, not null.
  - combine
```
MonetarySummaryStatistics combine(MonetarySummaryStatistics summaryStatistics)
```
    Combines the state of another MonetarySummaryStatistics into this one.
    
    Parameters:
    
    summaryStatistics - another MonetarySummaryStatistics, not null.
  - getCount
```
long getCount()
```
    Get the number of items added to this summary instance.
    
    Returns:
    
    the number of summarized items, >= 0.
  - getMin
```
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
```
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
```
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
```
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.
  - getCurrencyUnit
```
CurrencyUnit getCurrencyUnit()
```
    the currency unit used in summary
    
    Returns:
    
    the currency unit
  - isExchangeable
```
boolean isExchangeable()
```
    return if is possible do exchange rate or not with the MonetarySummary
    
    Returns:
    
    false;
  - to
```
MonetarySummaryStatistics to(CurrencyUnit unit)
```
    created the MonetarySummaryStatistics converted to CurrencyUnit
    
    Parameters:
    
    unit - to be converted
    
    Returns:
    
    MonetarySummaryStatistics converted
    
    Throws:
    
    UnsupportedOperationException - if isExchangeable() was false
    
    NullPointerException - if unit was null

Interface MonetarySummaryStatistics

Method Summary

Method Detail

accept

combine

getCount

getMin

getMax

getSum

getAverage

getCurrencyUnit

isExchangeable

to