net.namibsun.papio.lib.money

Class CurrencyConverter

net.namibsun.papio.lib.money.CurrencyConverter

public class CurrencyConverter

Singleton object that handles the exchanging of monetary values from one currency to another.

Field Summary

Fields

Modifier and Type	Field and Description
static CurrencyConverter	INSTANCE Singleton object that handles the exchanging of monetary values from one currency to another.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	convertValue(java.math.BigDecimal value, Currency source, Currency destination) Converts a value from one currency to another.
java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal>	generateCache() Sets the cache to the current exchange rates and return that value.
java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal>	getExchangeRateData()
boolean	getNetworkDisabled() Can be set to true to disable any network operations. Originally added to enable testing the caching functionality.
boolean	isValid() Checks if the values are currently valid
void	setCache(java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal> cache) Sets the cache variable as a fallback for currency exchange rates that could not be found
void	setCacheFile(java.io.File cacheFile) Sets the cache file. This file will be used to store cached exchange rates
void	setNetworkDisabled(boolean p) Can be set to true to disable any network operations. Originally added to enable testing the caching functionality.
void	update(boolean force, boolean reset) Updates the exchange rate data. Will only update if more than a minute has passed since the last update or if the force variable is set to true.

Field Detail

INSTANCE

public static CurrencyConverter INSTANCE

Singleton object that handles the exchanging of monetary values from one currency to another.

Method Detail

getNetworkDisabled

public boolean getNetworkDisabled()

Can be set to true to disable any network operations. Originally added to enable testing the caching functionality.

setNetworkDisabled

public void setNetworkDisabled(boolean p)

Can be set to true to disable any network operations. Originally added to enable testing the caching functionality.

getExchangeRateData

public java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal> getExchangeRateData()

Returns:

The internal exchange rate data map

setCacheFile

public void setCacheFile(java.io.File cacheFile)

Sets the cache file. This file will be used to store cached exchange rates

Parameters:

cacheFile - : The file in which to store the cached data

setCache

public void setCache(java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal> cache)

Sets the cache variable as a fallback for currency exchange rates that could not be found

Parameters:

cache - : The cache to set

generateCache

public java.util.Map<net.namibsun.papio.lib.money.Currency,java.math.BigDecimal> generateCache()

Sets the cache to the current exchange rates and return that value.

Returns:

The new cache value

isValid

public boolean isValid()

Checks if the values are currently valid

Returns:

true if the values are valid. Else, return false.

update

public void update(boolean force,
                   boolean reset)

Updates the exchange rate data. Will only update if more than a minute has passed since the last update or if the force variable is set to true.

Parameters:

force - : Forces an update if set to true

reset - : Resets the internal exchange rate data before updating

convertValue

public java.math.BigDecimal convertValue(java.math.BigDecimal value,
                                         Currency source,
                                         Currency destination)

Converts a value from one currency to another.

Parameters:

value - : The value to convert

source - : The source currency from which to convert from

destination - : The destination currency into which to convert to

Returns:

The converted value as a BigDecimal