org.broadleafcommerce.common.currency.util

Class BroadleafCurrencyUtils

java.lang.Object

org.broadleafcommerce.common.currency.util.BroadleafCurrencyUtils

public class BroadleafCurrencyUtils
extends Object

Utility methods for common currency operations

Author:

Phillip Verheyden

See Also:

BroadleafCurrency}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BroadleafCurrencyUtils.CurrencyLocation

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,NumberFormat>	FORMAT_CACHE
static MathContext	ROUND_FLOOR_MATH_CONTEXT

Constructor Summary

Constructors

Constructor and Description
BroadleafCurrencyUtils()

Method Summary

Modifier and Type	Method and Description
static int	calculateRemainder(Money totalAmount, int quantity) Returns the remainder amount if the passed in totalAmount was divided by the quantity taking into account the normal unit of the currency (e.g.
protected static BroadleafCurrencyUtils.CurrencyLocation	currencyLocation(String location)
static Currency	getCurrency(BroadleafCurrency currency)
static Currency	getCurrency(Money money)
static Money	getMoney(BigDecimal amount)
static Money	getMoney(BigDecimal amount, BroadleafCurrency currency)
static Money	getMoney(BroadleafCurrency currency)
static NumberFormat	getNumberFormatFromCache(Locale locale, Currency currency) Provides a cached approach for creating NumberFormat instances.
static NumberFormat	getNumberFormatFromCache(Locale locale, Currency currency, String location, List<String> currencyCodes)
static Money	getUnitAmount(BroadleafCurrency blCurrency) Returns the unit amount (e.g.
static Money	getUnitAmount(Money difference) Returns the unit amount (e.g.
protected static void	prefixCurrencyLocation(DecimalFormat format, List<String> currencyCodes)
protected static void	specifyCurrencyLocation(DecimalFormat format, String location, List<String> currencyCodes)
protected static void	suffixCurrencyLocation(DecimalFormat format, List<String> currencyCodes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_CACHE

protected static final Map<String,NumberFormat> FORMAT_CACHE

ROUND_FLOOR_MATH_CONTEXT

public static final MathContext ROUND_FLOOR_MATH_CONTEXT

Constructor Detail

BroadleafCurrencyUtils

public BroadleafCurrencyUtils()

Method Detail

getMoney

public static Money getMoney(BigDecimal amount,
                             BroadleafCurrency currency)

getMoney

public static Money getMoney(BigDecimal amount)

getMoney

public static Money getMoney(BroadleafCurrency currency)

getCurrency

public static Currency getCurrency(Money money)

getCurrency

public static Currency getCurrency(BroadleafCurrency currency)

getUnitAmount

public static Money getUnitAmount(Money difference)

Returns the unit amount (e.g. .01 for US and all other 2 decimal currencies)

Parameters:

difference -

Returns:

getUnitAmount

public static Money getUnitAmount(BroadleafCurrency blCurrency)

Returns the unit amount (e.g. .01 for US and all other 2 decimal currencies)

Parameters:

blCurrency -

Returns:

calculateRemainder

public static int calculateRemainder(Money totalAmount,
                                     int quantity)

Returns the remainder amount if the passed in totalAmount was divided by the quantity taking into account the normal unit of the currency (e.g. .01 for US).

Parameters:

totalAmount -

quantity -

Returns:

getNumberFormatFromCache

public static NumberFormat getNumberFormatFromCache(Locale locale,
                                                    Currency currency)

Provides a cached approach for creating NumberFormat instances. More performant than creating a new one each time.

Parameters:

locale - the Locale

currency - the Currency

Returns:

either a new NumberFormat instance, or one taken from the cache

getNumberFormatFromCache

public static NumberFormat getNumberFormatFromCache(Locale locale,
                                                    Currency currency,
                                                    String location,
                                                    List<String> currencyCodes)

specifyCurrencyLocation

protected static void specifyCurrencyLocation(DecimalFormat format,
                                              String location,
                                              List<String> currencyCodes)

currencyLocation

protected static BroadleafCurrencyUtils.CurrencyLocation currencyLocation(String location)

suffixCurrencyLocation

protected static void suffixCurrencyLocation(DecimalFormat format,
                                             List<String> currencyCodes)

prefixCurrencyLocation

protected static void prefixCurrencyLocation(DecimalFormat format,
                                             List<String> currencyCodes)