javax.money.convert

Class MonetaryConversions

java.lang.Object

javax.money.convert.MonetaryConversions

public final class MonetaryConversions
extends Object

This singleton defines access to the exchange and currency conversion logic of JavaMoney. It allows to evaluate the currently available exchange rate type instances and provides access to the corresponding ExchangeRateProvider and CurrencyConversion instances.

This class is thread safe.

This class is designed to support also contextual behaviour, e.g. in Java EE containers each application may provide its own ExchangeRateProvider instances, e.g. by registering them as CDI beans. An EE container can register an according MonetaryConversionsSingletonSpi that manages the different application contexts transparently. In a SE environment this class is expected to behave like an ordinary singleton, loading its SPIs e.g. from the JDK ServiceLoader or an alternate component and service provider.

This class is thread-safe. Hereby it is important to know that it delegates to the registered MonetaryConversionsSingletonSpi SPI, which also is required to be thread-safe.

Author:

Anatole Tresch, Werner Keil

Method Summary

Modifier and Type	Method and Description
static CurrencyConversion	getConversion(ConversionQuery conversionQuery) Access an instance of CurrencyConversion for the given providers.
static CurrencyConversion	getConversion(CurrencyUnit termCurrency, String... providers) Access an instance of CurrencyConversion for the given providers.
static CurrencyConversion	getConversion(String termCurrencyCode, String... providers) Access an instance of CurrencyConversion for the given providers.
static Collection<String>	getConversionProviderNames() Return the (non localized) names of all providers available in the current context.
static List<String>	getDefaultConversionProviderChain() Get the default provider used.
static ExchangeRateProvider	getExchangeRateProvider(ConversionQuery conversionQuery) Access an instance of CurrencyConversion using the given providers as a provider chain.
static ExchangeRateProvider	getExchangeRateProvider(ExchangeRateProviderSupplier provider, ExchangeRateProviderSupplier... providers) Access an instance of CurrencyConversion using the ExchangeRateProviderSupplier.
static ExchangeRateProvider	getExchangeRateProvider(String... providers) Access an instance of CurrencyConversion using the given providers as a provider chain.
static boolean	isConversionAvailable(ConversionQuery conversionQuery) Checks if a CurrencyConversion is available for the given parameters.
static boolean	isConversionAvailable(CurrencyUnit termCurrency, String... providers) Checks if a CurrencyConversion is available for the given parameters.
static boolean	isConversionAvailable(String currencyCode, String... providers) Checks if a CurrencyConversion is available for the given parameters.
static boolean	isExchangeRateProviderAvailable(ConversionQuery conversionQuery) Checks if a ExchangeRateProvider is available for the given parameters.

Methods inherited from class java.lang.Object

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

Method Detail

getConversion

public static CurrencyConversion getConversion(CurrencyUnit termCurrency,
                                               String... providers)

Access an instance of CurrencyConversion for the given providers. Use getConversionProviderNames() to check, which are available.

Parameters:

termCurrency - the terminating or target currency, not null

providers - Additional providers, for building a provider chain

Returns:

the exchange rate type if this instance.

Throws:

IllegalArgumentException - if no such ExchangeRateProvider is available.

getConversion

public static CurrencyConversion getConversion(String termCurrencyCode,
                                               String... providers)

Access an instance of CurrencyConversion for the given providers. Use getConversionProviderNames()} to check, which are available.

Parameters:

termCurrencyCode - the terminating or target currency code, not null

providers - Additional providers, for building a provider chain

Returns:

the exchange rate type if this instance.

Throws:

MonetaryException - if no such ExchangeRateProvider is available or if no CurrencyUnit was matching the given currency code.

getConversion

public static CurrencyConversion getConversion(ConversionQuery conversionQuery)

Access an instance of CurrencyConversion for the given providers. Use getConversionProviderNames()} to check, which are available.

Parameters:

conversionQuery - The ConversionQuery required, not null

Returns:

the CurrencyConversion instance matching.

Throws:

IllegalArgumentException - if the query defines ExchangeRateProviders that are not available.

isConversionAvailable

public static boolean isConversionAvailable(ConversionQuery conversionQuery)

Checks if a CurrencyConversion is available for the given parameters.

Parameters:

conversionQuery - the ConversionQuery, not null.

Returns:

true, if a conversion is accessible from getConversion(ConversionQuery).

isConversionAvailable

public static boolean isConversionAvailable(String currencyCode,
                                            String... providers)

Checks if a CurrencyConversion is available for the given parameters.

Parameters:

currencyCode - The currencoy code, resolvable by (String, String...)

providers - Additional providers, for building a provider chain

Returns:

true, if a conversion is accessible from getConversion(String, String...).

isConversionAvailable

public static boolean isConversionAvailable(CurrencyUnit termCurrency,
                                            String... providers)

Checks if a CurrencyConversion is available for the given parameters.

Parameters:

termCurrency - the terminating or target currency, not null

providers - Additional providers, for building a provider chain

Returns:

true, if a conversion is accessible from getConversion(String, String...).

getExchangeRateProvider

public static ExchangeRateProvider getExchangeRateProvider(String... providers)

Access an instance of CurrencyConversion using the given providers as a provider chain. Use getConversionProviderNames()s to check, which are available.

Returns:

the exchange rate provider.

Throws:

IllegalArgumentException - if no such ExchangeRateProvider is available.

getExchangeRateProvider

public static ExchangeRateProvider getExchangeRateProvider(ExchangeRateProviderSupplier provider,
                                                           ExchangeRateProviderSupplier... providers)

Access an instance of CurrencyConversion using the ExchangeRateProviderSupplier.

Parameters:

provider - the exchange rate provider.

providers - the exchange rate provider.

Returns:

the exchange rate provider.

Throws:

IllegalArgumentException - if no such ExchangeRateProvider is available.

getExchangeRateProvider

public static ExchangeRateProvider getExchangeRateProvider(ConversionQuery conversionQuery)

Access an instance of CurrencyConversion using the given providers as a provider chain. Use getConversionProviderNames() to check, which are available.

Returns:

the exchange rate provider.

Throws:

IllegalArgumentException - if no such ExchangeRateProvider is available.

isExchangeRateProviderAvailable

public static boolean isExchangeRateProviderAvailable(ConversionQuery conversionQuery)

Checks if a ExchangeRateProvider is available for the given parameters.

Parameters:

conversionQuery - the ConversionQuery, not null.

Returns:

true, if a rate provider is accessible from getExchangeRateProvider(ConversionQuery)}.

getConversionProviderNames

public static Collection<String> getConversionProviderNames()

Return the (non localized) names of all providers available in the current context. Each id can be used to obtain ExchangeRateProvider or CurrencyConversion instances.

Returns:

all supported provider ids, never null.

getDefaultConversionProviderChain

public static List<String> getDefaultConversionProviderChain()

Get the default provider used.

Returns:

the default provider, never null.