org.javamoney.moneta.function

Class MonetaryFunctions

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()

Method Summary

Modifier and Type	Method and Description
static Comparator<MonetaryAmount>	sortCurrencyUnit() Get a comparator for sorting CurrencyUnits ascending.
static Comparator<MonetaryAmount>	sortCurrencyUnitDesc() Get a comparator for sorting CurrencyUnits descending.
static Comparator<MonetaryAmount>	sortNumber() Get a comparator for sorting amount by number value ascending.
static Comparator<MonetaryAmount>	sortNumberDesc() Get a comparator for sorting amount by number value descending.
static Comparator<? super MonetaryAmount>	sortValiable(ExchangeRateProvider provider) Deprecated. call #sortValuable instead of.
static Comparator<? super MonetaryAmount>	sortValiableDesc(ExchangeRateProvider provider) Deprecated. Use #sortValiableDesc instead of.
static Comparator<? super MonetaryAmount>	sortValuable(ExchangeRateProvider provider) comparator to sort the MonetaryAmount considering the ExchangeRate
static Comparator<? super MonetaryAmount>	sortValuableDesc(ExchangeRateProvider provider) Descending order of sortValuable(ExchangeRateProvider)
static MonetaryAmount	sum(MonetaryAmount a, MonetaryAmount b) Adds two monetary together

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

sortCurrencyUnit

public static Comparator<MonetaryAmount> sortCurrencyUnit()

Get a comparator for sorting CurrencyUnits ascending.

Returns:

the Comparator to sort by CurrencyUnit in ascending order, not null.

sortValuable

public static Comparator<? super MonetaryAmount> sortValuable(ExchangeRateProvider provider)

comparator to sort the MonetaryAmount considering the ExchangeRate

Parameters:

provider - the rate provider to be used.

Returns:

the sort of MonetaryAmount using ExchangeRate

sortValiable

@Deprecated
public static Comparator<? super MonetaryAmount> sortValiable(ExchangeRateProvider provider)

Deprecated. call #sortValuable instead of.

comparator to sort the MonetaryAmount considering the ExchangeRate

Parameters:

provider - the rate provider to be used.

Returns:

the sort of MonetaryAmount using ExchangeRate

sortValuableDesc

public static Comparator<? super MonetaryAmount> sortValuableDesc(ExchangeRateProvider provider)

Descending order of sortValuable(ExchangeRateProvider)

Parameters:

provider - the rate provider to be used.

Returns:

the Descending order of sortValuable(ExchangeRateProvider)

sortValiableDesc

@Deprecated
public static Comparator<? super MonetaryAmount> sortValiableDesc(ExchangeRateProvider provider)

Deprecated. Use #sortValiableDesc instead of.

Descending order of sortValuable(ExchangeRateProvider)

Parameters:

provider - the rate provider to be used.

Returns:

the Descending order of sortValuable(ExchangeRateProvider)

sortCurrencyUnitDesc

public static Comparator<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<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<MonetaryAmount> sortNumberDesc()

Get a comparator for sorting amount by number value descending.

Returns:

the Comparator to sort by number in descending way, not null.

sum

public static MonetaryAmount sum(MonetaryAmount a,
                                 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

MonetaryException - if a and b have different currency