org.javamoney.moneta.spi

Class ConfigurableCurrencyUnitProvider

java.lang.Object

org.javamoney.moneta.spi.base.BaseCurrencyProviderSpi

org.javamoney.moneta.spi.ConfigurableCurrencyUnitProvider

All Implemented Interfaces:

CurrencyProviderSpi

public class ConfigurableCurrencyUnitProvider
extends BaseCurrencyProviderSpi

This class provides a programmatic singleton for globally registering new Currency into the Monetary singleton either by currency code, locale, or both.

Constructor Summary

Constructors

Constructor and Description
ConfigurableCurrencyUnitProvider()

Method Summary

Modifier and Type	Method and Description
Set<CurrencyUnit>	getCurrencies(CurrencyQuery currencyQuery) Return a CurrencyUnit instances matching the given CurrencyContext.
static CurrencyUnit	registerCurrencyUnit(CurrencyUnit currencyUnit) Registers a new currency unit under its currency code and potentially numeric code.
static CurrencyUnit	registerCurrencyUnit(CurrencyUnit currencyUnit, Locale locale) Registers a new currency unit under the given Locale.
static CurrencyUnit	removeCurrencyUnit(Locale locale) Removes a CurrencyUnit.
static CurrencyUnit	removeCurrencyUnit(String currencyCode) Removes a CurrencyUnit.
String	toString()

Methods inherited from class org.javamoney.moneta.spi.base.BaseCurrencyProviderSpi

getProviderName, isCurrencyAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableCurrencyUnitProvider

public ConfigurableCurrencyUnitProvider()

Method Detail

getCurrencies

public Set<CurrencyUnit> getCurrencies(CurrencyQuery currencyQuery)

Return a CurrencyUnit instances matching the given CurrencyContext.

Parameters:

currencyQuery - the CurrencyQuery containing the parameters determining the query. not null.

Returns:

the corresponding CurrencyUnit, or null, if no such unit is provided by this provider.

registerCurrencyUnit

public static CurrencyUnit registerCurrencyUnit(CurrencyUnit currencyUnit)

Registers a new currency unit under its currency code and potentially numeric code.

Parameters:

currencyUnit - the new currency to be registered, not null.

Returns:

any unit instance registered previously by this instance, or null.

registerCurrencyUnit

public static CurrencyUnit registerCurrencyUnit(CurrencyUnit currencyUnit,
                                                Locale locale)

Registers a new currency unit under the given Locale.

Parameters:

currencyUnit - the new currency to be registered, not null.

locale - the Locale, not null.

Returns:

any unit instance registered previously by this instance, or null.

removeCurrencyUnit

public static CurrencyUnit removeCurrencyUnit(String currencyCode)

Removes a CurrencyUnit.

Parameters:

currencyCode - the currency code, not null.

Returns:

any unit instance removed, or null.

removeCurrencyUnit

public static CurrencyUnit removeCurrencyUnit(Locale locale)

Removes a CurrencyUnit.

Parameters:

locale - the Locale, not null.

Returns:

any unit instance removed, or null.

toString

public String toString()

Overrides:

toString in class Object