MonetaryFunctions (Moneta (JSR 354 RI) 0.9 API)

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

```
public final class MonetaryFunctions
extends Object
```
This singleton class provides access to the predefined monetary functions.

Author:

otaviojava, anatole

Constructor Summary

Constructors
Constructor and Description

MonetaryFunctions()

Constructors
Constructor and Description
`MonetaryFunctions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`fiterByExcludingCurrency(javax.money.CurrencyUnit... currencies)` Create predicate that filters by CurrencyUnit.
`static java.util.stream.Collector<javax.money.MonetaryAmount,?,Map<javax.money.CurrencyUnit,List<javax.money.MonetaryAmount>>>`	`groupByCurrencyUnit()` Collector to group by CurrencyUnit
`static java.util.stream.Collector<javax.money.MonetaryAmount,GroupMonetarySummaryStatistics,GroupMonetarySummaryStatistics>`	`groupBySummarizingMonetary()` of MonetaryAmount group by MonetarySummary
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isBetween(javax.money.MonetaryAmount min, javax.money.MonetaryAmount max)` Creates a filter using the isBetween predicate.
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isCurrency(javax.money.CurrencyUnit... currencies)` Create predicate that filters by CurrencyUnit.
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isGreaterThan(javax.money.MonetaryAmount amount)` Creates filter using isGreaterThan in MonetaryAmount.
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)` Creates filter using isGreaterThanOrEqualTo in MonetaryAmount
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isLessThan(javax.money.MonetaryAmount amount)` Creates filter using isLessThan in MonetaryAmount
`static java.util.function.Predicate<javax.money.MonetaryAmount>`	`isLessThanOrEqualTo(javax.money.MonetaryAmount amount)` Creates filter using isLessThanOrEqualTo in MonetaryAmount
`static java.util.function.BinaryOperator<javax.money.MonetaryAmount>`	`max()` Creates a BinaryOperator to calculate the maximum amount.
`static javax.money.MonetaryAmount`	`max(javax.money.MonetaryAmount a, javax.money.MonetaryAmount b)` Returns the greater of two `MonetaryAmount` values.
`static java.util.function.BinaryOperator<javax.money.MonetaryAmount>`	`min()` Creates a BinaryOperator to calculate the minimum amount
`static javax.money.MonetaryAmount`	`min(javax.money.MonetaryAmount a, javax.money.MonetaryAmount b)` Returns the smaller of two `MonetaryAmount` values.
`static Comparator<javax.money.MonetaryAmount>`	`sortCurrencyUnit()` Get a comparator for sorting CurrencyUnits ascending.
`static Comparator<javax.money.MonetaryAmount>`	`sortCurrencyUnitDesc()` Get a comparator for sorting CurrencyUnits descending.
`static Comparator<javax.money.MonetaryAmount>`	`sortNumber()` Get a comparator for sorting amount by number value ascending.
`static Comparator<javax.money.MonetaryAmount>`	`sortNumberDesc()` Get a comparator for sorting amount by number value descending.
`static java.util.function.BinaryOperator<javax.money.MonetaryAmount>`	`sum()` Creates a BinaryOperator to sum.
`static javax.money.MonetaryAmount`	`sum(javax.money.MonetaryAmount a, javax.money.MonetaryAmount b)` Adds two monetary together
`static java.util.stream.Collector<javax.money.MonetaryAmount,MonetarySummaryStatistics,MonetarySummaryStatistics>`	`summarizingMonetary(javax.money.CurrencyUnit currencyUnit)` of the summary of the MonetaryAmount

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

- Constructor Detail
  - MonetaryFunctions
```
public MonetaryFunctions()
```
- Method Detail
  - groupByCurrencyUnit
```
public static java.util.stream.Collector<javax.money.MonetaryAmount,?,Map<javax.money.CurrencyUnit,List<javax.money.MonetaryAmount>>> groupByCurrencyUnit()
```
    Collector to group by CurrencyUnit
    
    Returns:
    
    the Collector to of Map>
  - summarizingMonetary
```
public static java.util.stream.Collector<javax.money.MonetaryAmount,MonetarySummaryStatistics,MonetarySummaryStatistics> summarizingMonetary(javax.money.CurrencyUnit currencyUnit)
```
    of the summary of the MonetaryAmount
    
    Parameters:
    
    currencyUnit - the target CurrencyUnit
    
    Returns:
    
    the MonetarySummaryStatistics
  - groupBySummarizingMonetary
```
public static java.util.stream.Collector<javax.money.MonetaryAmount,GroupMonetarySummaryStatistics,GroupMonetarySummaryStatistics> groupBySummarizingMonetary()
```
    of MonetaryAmount group by MonetarySummary
    
    Returns:
    
    the MonetarySummaryStatistics
  - sortCurrencyUnit
```
public static Comparator<javax.money.MonetaryAmount> sortCurrencyUnit()
```
    Get a comparator for sorting CurrencyUnits ascending.
    
    Returns:
    
    the Comparator to sort by CurrencyUnit in ascending order, not null.
  - sortCurrencyUnitDesc
```
public static Comparator<javax.money.MonetaryAmount> sortCurrencyUnitDesc()
```
    Get a comparator for sorting CurrencyUnits descending.
    
    Returns:
    
    the Comparator to sort by CurrencyUnit in descending order, not null.
  - sortNumber
```
public static Comparator<javax.money.MonetaryAmount> sortNumber()
```
    Get a comparator for sorting amount by number value ascending.
    
    Returns:
    
    the Comparator to sort by number in ascending way, not null.
  - sortNumberDesc
```
public static Comparator<javax.money.MonetaryAmount> sortNumberDesc()
```
    Get a comparator for sorting amount by number value descending.
    
    Returns:
    
    the Comparator to sort by number in descending way, not null.
  - isCurrency
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isCurrency(javax.money.CurrencyUnit... currencies)
```
    Create predicate that filters by CurrencyUnit.
    
    Parameters:
    
    currencies - the target CurrencyUnit
    
    Returns:
    
    the predicate from CurrencyUnit
  - fiterByExcludingCurrency
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> fiterByExcludingCurrency(javax.money.CurrencyUnit... currencies)
```
    Create predicate that filters by CurrencyUnit.
    
    Parameters:
    
    currencies - the target CurrencyUnit instances to be filtered.
    
    Returns:
    
    the predicate from CurrencyUnit
  - isGreaterThan
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isGreaterThan(javax.money.MonetaryAmount amount)
```
    Creates filter using isGreaterThan in MonetaryAmount.
    
    Parameters:
    
    amount - the amount to be compared, not null.
    
    Returns:
    
    the filter with isGreaterThan conditions
  - isGreaterThanOrEqualTo
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Creates filter using isGreaterThanOrEqualTo in MonetaryAmount
    
    Parameters:
    
    amount - the amount to be compared, not null.
    
    Returns:
    
    the filter with isGreaterThanOrEqualTo conditions
  - isLessThan
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isLessThan(javax.money.MonetaryAmount amount)
```
    Creates filter using isLessThan in MonetaryAmount
    
    Parameters:
    
    amount - the amount to be compared, not null.
    
    Returns:
    
    the filter with isLessThan conditions
  - isLessThanOrEqualTo
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isLessThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Creates filter using isLessThanOrEqualTo in MonetaryAmount
    
    Parameters:
    
    amount - the amount to be compared, not null.
    
    Returns:
    
    the filter with isLessThanOrEqualTo conditions
  - isBetween
```
public static java.util.function.Predicate<javax.money.MonetaryAmount> isBetween(javax.money.MonetaryAmount min,
                                                                                 javax.money.MonetaryAmount max)
```
    Creates a filter using the isBetween predicate.
    
    Parameters:
    
    min - min value inclusive, not null.
    
    max - max value inclusive, not null.
    
    Returns:
    
    the Predicate between min and max.
  - sum
```
public static javax.money.MonetaryAmount sum(javax.money.MonetaryAmount a,
                                             javax.money.MonetaryAmount b)
```
    Adds two monetary together
    
    Parameters:
    
    a - the first operand
    
    b - the second operand
    
    Returns:
    
    the sum of a and b
    
    Throws:
    
    NullPointerException - if a o b be null
    
    javax.money.MonetaryException - if a and b have different currency
  - min
```
public static javax.money.MonetaryAmount min(javax.money.MonetaryAmount a,
                                             javax.money.MonetaryAmount b)
```
    Returns the smaller of two MonetaryAmount values. If the arguments have the same value, the result is that same value.
    
    Parameters:
    
    a - an argument.
    
    b - another argument.
    
    Returns:
    
    the smaller of a and b.
  - max
```
public static javax.money.MonetaryAmount max(javax.money.MonetaryAmount a,
                                             javax.money.MonetaryAmount b)
```
    Returns the greater of two MonetaryAmount values. If the arguments have the same value, the result is that same value.
    
    Parameters:
    
    a - an argument.
    
    b - another argument.
    
    Returns:
    
    the larger of a and b.
  - sum
```
public static java.util.function.BinaryOperator<javax.money.MonetaryAmount> sum()
```
    Creates a BinaryOperator to sum.
    
    Returns:
    
    the sum BinaryOperator, not null.
  - min
```
public static java.util.function.BinaryOperator<javax.money.MonetaryAmount> min()
```
    Creates a BinaryOperator to calculate the minimum amount
    
    Returns:
    
    the min BinaryOperator, not null.
  - max
```
public static java.util.function.BinaryOperator<javax.money.MonetaryAmount> max()
```
    Creates a BinaryOperator to calculate the maximum amount.
    
    Returns:
    
    the max BinaryOperator, not null.

Class MonetaryFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonetaryFunctions

Method Detail

groupByCurrencyUnit

summarizingMonetary

groupBySummarizingMonetary

sortCurrencyUnit

sortCurrencyUnitDesc

sortNumber

sortNumberDesc

isCurrency

fiterByExcludingCurrency

isGreaterThan

isGreaterThanOrEqualTo

isLessThan

isLessThanOrEqualTo

isBetween

sum

min

max

sum

min

max