DefaultMonetarySummaryStatistics (Moneta (JSR 354 RI) 1.1 API)

java.lang.Object
- org.javamoney.moneta.function.DefaultMonetarySummaryStatistics

All Implemented Interfaces:

MonetarySummaryStatistics
```
public class DefaultMonetarySummaryStatistics
extends Object
implements MonetarySummaryStatistics
```
the default implementations of MonetarySummaryStatistics This implementations cannot do exchange rate

Author:

otaviojava, Anatole Tresch

Field Summary

Fields
Modifier and Type	Field and Description
`protected javax.money.MonetaryAmount`	`average`
`protected long`	`count`
`protected javax.money.MonetaryAmount`	`max`
`protected javax.money.MonetaryAmount`	`min`
`protected javax.money.MonetaryAmount`	`sum`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultMonetarySummaryStatistics(javax.money.CurrencyUnit currencyUnit)` Creates a new instance, targeting the given `CurrencyUnit`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`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.CurrencyUnit`	`getCurrencyUnit()` the currency unit used in summary
`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()`
`boolean`	`isExchangeable()` return if is possible do exchange rate or not with the MonetarySummary
`static DefaultMonetarySummaryStatistics`	`of(javax.money.CurrencyUnit currencyUnit)` Creates a new instance, targeting the given `CurrencyUnit`.
`MonetarySummaryStatistics`	`to(javax.money.CurrencyUnit unit)` created the MonetarySummaryStatistics converted to `CurrencyUnit`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - count
```
protected long count
```
  - min
```
protected javax.money.MonetaryAmount min
```
  - max
```
protected javax.money.MonetaryAmount max
```
  - sum
```
protected javax.money.MonetaryAmount sum
```
  - average
```
protected javax.money.MonetaryAmount average
```
- Constructor Detail
  - DefaultMonetarySummaryStatistics
```
protected DefaultMonetarySummaryStatistics(javax.money.CurrencyUnit currencyUnit)
```
    Creates a new instance, targeting the given CurrencyUnit.
    
    Parameters:
    
    currencyUnit - the target currency, not null.
- Method Detail
  - of
```
public static DefaultMonetarySummaryStatistics of(javax.money.CurrencyUnit currencyUnit)
```
    Creates a new instance, targeting the given CurrencyUnit.
    
    Parameters:
    
    currencyUnit - the target currency, not null.
  - accept
```
public void accept(javax.money.MonetaryAmount amount)
```
    Description copied from interface: MonetarySummaryStatistics
    
    Records another value into the summary information.
    
    Specified by:
    
    accept in interface MonetarySummaryStatistics
    
    Parameters:
    
    amount - the input amount value to be added, not null.
  - getCurrencyUnit
```
public javax.money.CurrencyUnit getCurrencyUnit()
```
    Description copied from interface: MonetarySummaryStatistics
    
    the currency unit used in summary
    
    Specified by:
    
    getCurrencyUnit in interface MonetarySummaryStatistics
    
    Returns:
    
    the currency unit
  - combine
```
public MonetarySummaryStatistics combine(MonetarySummaryStatistics summaryStatistics)
```
    Description copied from interface: MonetarySummaryStatistics
    
    Combines the state of another MonetarySummaryStatistics into this one.
    
    Specified by:
    
    combine in interface MonetarySummaryStatistics
    
    Parameters:
    
    summaryStatistics - another MonetarySummaryStatistics, not null.
  - getCount
```
public long getCount()
```
    Description copied from interface: MonetarySummaryStatistics
    
    Get the number of items added to this summary instance.
    
    Specified by:
    
    getCount in interface MonetarySummaryStatistics
    
    Returns:
    
    the number of summarized items, >= 0.
  - getMin
```
public javax.money.MonetaryAmount getMin()
```
    Description copied from interface: MonetarySummaryStatistics
    
    Get the minimal amount found within this summary.
    
    Specified by:
    
    getMin in interface MonetarySummaryStatistics
    
    Returns:
    
    the minimal amount, or null if no amount was added to this summary instance.
  - getMax
```
public javax.money.MonetaryAmount getMax()
```
    Description copied from interface: MonetarySummaryStatistics
    
    Get the maximal amount found within this summary.
    
    Specified by:
    
    getMax in interface MonetarySummaryStatistics
    
    Returns:
    
    the minimal amount, or null if no amount was added to this summary instance.
  - getSum
```
public javax.money.MonetaryAmount getSum()
```
    Description copied from interface: MonetarySummaryStatistics
    
    Get the sum of all amounts within this summary.
    
    Specified by:
    
    getSum in interface MonetarySummaryStatistics
    
    Returns:
    
    the total amount, or null if no amount was added to this summary instance.
  - getAverage
```
public javax.money.MonetaryAmount getAverage()
```
    Description copied from interface: MonetarySummaryStatistics
    
    Get the mean average of all amounts added.
    
    Specified by:
    
    getAverage in interface MonetarySummaryStatistics
    
    Returns:
    
    the mean average amount, or null if no amount was added to this summary instance.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isExchangeable
```
public boolean isExchangeable()
```
    Description copied from interface: MonetarySummaryStatistics
    
    return if is possible do exchange rate or not with the MonetarySummary
    
    Specified by:
    
    isExchangeable in interface MonetarySummaryStatistics
    
    Returns:
    
    false;
  - to
```
public MonetarySummaryStatistics to(javax.money.CurrencyUnit unit)
```
    Description copied from interface: MonetarySummaryStatistics
    
    created the MonetarySummaryStatistics converted to CurrencyUnit
    
    Specified by:
    
    to in interface MonetarySummaryStatistics
    
    Parameters:
    
    unit - to be converted
    
    Returns:
    
    MonetarySummaryStatistics converted

Class DefaultMonetarySummaryStatistics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

count

min

max

sum

average

Constructor Detail

DefaultMonetarySummaryStatistics

Method Detail

of

accept

getCurrencyUnit

combine

getCount

getMin

getMax

getSum

getAverage

equals

hashCode

toString

isExchangeable

to