Module java.money

Package javax.money

Class Monetary

java.lang.Object

javax.money.Monetary

public final class Monetary
extends Object

Factory singleton for CurrencyUnit, MonetaryAmount and MonetaryRounding instances as provided by the different registered SPI instances.

This class is thread safe.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Monetary()	Private singletons constructor.

Method Summary

Modifier and Type	Method	Description
static Collection<MonetaryAmountFactory<?>>	getAmountFactories()	Access all currently available MonetaryAmount implementation classes that are accessible from this MonetaryAmount singleton.
static Collection<MonetaryAmountFactory<?>>	getAmountFactories(MonetaryAmountFactoryQuery query)	Returns all factory instances that match the query.
static <T extends MonetaryAmount> MonetaryAmountFactory<T>	getAmountFactory(Class<T> amountType)	Access an MonetaryAmountFactory for the given MonetaryAmount implementation type.
static MonetaryAmountFactory	getAmountFactory(MonetaryAmountFactoryQuery query)	Executes the query and returns the factory found, if there is only one factory.
static Collection<Class<? extends MonetaryAmount>>	getAmountTypes()	Access all currently available MonetaryAmount implementation classes that are accessible from this MonetaryAmount singleton.
static Collection<CurrencyUnit>	getCurrencies(String... providers)	Access all currencies known.
static Set<CurrencyUnit>	getCurrencies(Locale locale, String... providers)	Access a new instance based on the Locale.
static Collection<CurrencyUnit>	getCurrencies(CurrencyQuery query)	Query all currencies matching the given query.
static CurrencyUnit	getCurrency(String currencyCode, String... providers)	Access a new instance based on the currency code.
static CurrencyUnit	getCurrency(Locale locale, String... providers)	Access a new instance based on the Locale.
static CurrencyUnit	getCurrency(CurrencyQuery query)	Query all currencies matching the given query.
static Set<String>	getCurrencyProviderNames()	Query all currencies matching the given query.
static MonetaryAmountFactory<?>	getDefaultAmountFactory()	Access the default MonetaryAmountFactory as defined by MonetaryAmountsSingletonSpi.getDefaultAmountFactory().
static Class<? extends MonetaryAmount>	getDefaultAmountType()	Access the default MonetaryAmount implementation class that is accessible from this MonetaryAmount singleton.
static List<String>	getDefaultCurrencyProviderChain()	Query the list and ordering of provider names modelling the default provider chain to be used, if no provider chain was explicitly set..
static MonetaryRounding	getDefaultRounding()	Creates a rounding that can be added as MonetaryOperator to chained calculations.
static List<String>	getDefaultRoundingProviderChain()	Allows to access the default providers chain used if no provider chain was passed explicitly..
static MonetaryRounding	getRounding(String roundingName, String... providers)	Access an MonetaryOperator for custom rounding MonetaryAmount instances.
static MonetaryRounding	getRounding(CurrencyUnit currencyUnit, String... providers)	Creates an MonetaryOperator for rounding MonetaryAmount instances given a currency.
static MonetaryRounding	getRounding(RoundingQuery roundingQuery)	Access a MonetaryRounding using a possibly complex query.
static Set<String>	getRoundingNames(String... providers)	Allows to access the names of the current defined roundings.
static Set<String>	getRoundingProviderNames()	Allows to access the names of the current registered providers.
static Collection<MonetaryRounding>	getRoundings(RoundingQuery roundingQuery)	Access multiple MonetaryRounding instances using a possibly complex query
static boolean	isAvailable(MonetaryAmountFactoryQuery query)	Allows to check if any of the getXXX methods return non empty/non null results of .MonetaryAmountFactory.
static boolean	isCurrencyAvailable(String code, String... providers)	Allows to check if a CurrencyUnit instance is defined, i.e.
static boolean	isCurrencyAvailable(Locale locale, String... providers)	Allows to check if a CurrencyUnit instance is defined, i.e.
static boolean	isRoundingAvailable(String roundingName, String... providers)	Checks if a MonetaryRounding is available given a roundingId.
static boolean	isRoundingAvailable(CurrencyUnit currencyUnit, String... providers)	Checks if a MonetaryRounding is available given a roundingId.
static boolean	isRoundingAvailable(RoundingQuery roundingQuery)	Checks if a MonetaryRounding matching the query is available.
private static MonetaryAmountsSingletonQuerySpi	monetaryAmountsSingletonQuerySpi()	The used MonetaryAmountsSingletonSpi instance.
private static MonetaryAmountsSingletonSpi	monetaryAmountsSingletonSpi()	The used MonetaryAmountsSingletonSpi instance.
private static MonetaryCurrenciesSingletonSpi	monetaryCurrenciesSingletonSpi()	The used MonetaryCurrenciesSingletonSpi instance.
private static MonetaryRoundingsSingletonSpi	monetaryRoundingsSingletonSpi()	The used MonetaryCurrenciesSingletonSpi instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Monetary

private Monetary()

Private singletons constructor.

Method Details

monetaryCurrenciesSingletonSpi

private static MonetaryCurrenciesSingletonSpi monetaryCurrenciesSingletonSpi()

The used MonetaryCurrenciesSingletonSpi instance.

Returns:

the used MonetaryCurrenciesSingletonSpi instance, never null

monetaryAmountsSingletonSpi

private static MonetaryAmountsSingletonSpi monetaryAmountsSingletonSpi()

The used MonetaryAmountsSingletonSpi instance.

monetaryAmountsSingletonQuerySpi

private static MonetaryAmountsSingletonQuerySpi monetaryAmountsSingletonQuerySpi()

The used MonetaryAmountsSingletonSpi instance.

monetaryRoundingsSingletonSpi

private static MonetaryRoundingsSingletonSpi monetaryRoundingsSingletonSpi()

The used MonetaryCurrenciesSingletonSpi instance.

Returns:

the used MonetaryCurrenciesSingletonSpi instance, never null

getRoundingProviderNames

public static Set<String> getRoundingProviderNames()

Allows to access the names of the current registered providers.

Returns:

the set of provider names, never null.

getDefaultRoundingProviderChain

public static List<String> getDefaultRoundingProviderChain()

Allows to access the default providers chain used if no provider chain was passed explicitly..

Returns:

the chained list of provider names, never null.

getDefaultRounding

public static MonetaryRounding getDefaultRounding()

Creates a rounding that can be added as MonetaryOperator to chained calculations. The instance will lookup the concrete MonetaryOperator instance from the Monetary based on the input MonetaryAmount's CurrencyUnit.

Returns:

the (shared) default rounding instance.

getRounding

public static MonetaryRounding getRounding(CurrencyUnit currencyUnit,
 String... providers)

Creates an MonetaryOperator for rounding MonetaryAmount instances given a currency.

Parameters:

currencyUnit - The currency, which determines the required scale. As RoundingMode, by default, RoundingMode.HALF_UP is used.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

a new instance MonetaryOperator implementing the rounding, never null.

getRounding

public static MonetaryRounding getRounding(String roundingName,
 String... providers)

Access an MonetaryOperator for custom rounding MonetaryAmount instances.

Parameters:

roundingName - The rounding identifier.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

the corresponding MonetaryOperator implementing the rounding, never null.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

getRounding

public static MonetaryRounding getRounding(RoundingQuery roundingQuery)

Access a MonetaryRounding using a possibly complex query.

Parameters:

roundingQuery - The RoundingQuery that may contains arbitrary parameters to be evaluated.

Returns:

the corresponding MonetaryRounding, never null.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

isRoundingAvailable

public static boolean isRoundingAvailable(String roundingName,
 String... providers)

Checks if a MonetaryRounding is available given a roundingId.

Parameters:

roundingName - The rounding identifier.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

true, if a corresponding MonetaryRounding is available.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

isRoundingAvailable

public static boolean isRoundingAvailable(CurrencyUnit currencyUnit,
 String... providers)

Checks if a MonetaryRounding is available given a roundingId.

Parameters:

currencyUnit - The currency, which determines the required scale. As RoundingMode, by default, RoundingMode.HALF_UP is used.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

true, if a corresponding MonetaryRounding is available.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

isRoundingAvailable

public static boolean isRoundingAvailable(RoundingQuery roundingQuery)

Checks if a MonetaryRounding matching the query is available.

Parameters:

roundingQuery - The RoundingQuery that may contains arbitrary parameters to be evaluated.

Returns:

true, if a corresponding MonetaryRounding is available.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

getRoundings

public static Collection<MonetaryRounding> getRoundings(RoundingQuery roundingQuery)

Access multiple MonetaryRounding instances using a possibly complex query

Parameters:

roundingQuery - The RoundingQuery that may contains arbitrary parameters to be evaluated.

Returns:

all MonetaryRounding instances matching the query, never null.

getRoundingNames

public static Set<String> getRoundingNames(String... providers)

Allows to access the names of the current defined roundings.

Parameters:

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

the set of custom rounding ids, never null.

getAmountFactory

public static <T extends MonetaryAmount>
MonetaryAmountFactory<T> getAmountFactory(Class<T> amountType)

Access an MonetaryAmountFactory for the given MonetaryAmount implementation type.

Parameters:

amountType - MonetaryAmount implementation type, nor null.

Returns:

the corresponding MonetaryAmountFactory, never null.

Throws:

MonetaryException - if no MonetaryAmountFactory targeting the given MonetaryAmount implementation class is registered.

getDefaultAmountFactory

public static MonetaryAmountFactory<?> getDefaultAmountFactory()

Access the default MonetaryAmountFactory as defined by MonetaryAmountsSingletonSpi.getDefaultAmountFactory().

Returns:

the MonetaryAmountFactory corresponding to default amount type, never null.

Throws:

MonetaryException - if no MonetaryAmountFactory targeting the default amount type implementation class is registered.

getAmountFactories

public static Collection<MonetaryAmountFactory<?>> getAmountFactories()

Access all currently available MonetaryAmount implementation classes that are accessible from this MonetaryAmount singleton.

Returns:

all currently available MonetaryAmount implementation classes that have corresponding MonetaryAmountFactory instances provided, never null

getAmountTypes

public static Collection<Class<? extends MonetaryAmount>> getAmountTypes()

Access all currently available MonetaryAmount implementation classes that are accessible from this MonetaryAmount singleton.

Returns:

all currently available MonetaryAmount implementation classes that have corresponding MonetaryAmountFactory instances provided, never null

getDefaultAmountType

public static Class<? extends MonetaryAmount> getDefaultAmountType()

Access the default MonetaryAmount implementation class that is accessible from this MonetaryAmount singleton.

Returns:

all current default MonetaryAmount implementation class, never null

getAmountFactory

public static MonetaryAmountFactory getAmountFactory(MonetaryAmountFactoryQuery query)

Executes the query and returns the factory found, if there is only one factory. If multiple factories match the query, one is selected.

Parameters:

query - the factory query, not null.

Returns:

the factory found, or null.

getAmountFactories

public static Collection<MonetaryAmountFactory<?>> getAmountFactories(MonetaryAmountFactoryQuery query)

Returns all factory instances that match the query.

Parameters:

query - the factory query, not null.

Returns:

the instances found, never null.

isAvailable

public static boolean isAvailable(MonetaryAmountFactoryQuery query)

Allows to check if any of the getXXX methods return non empty/non null results of .MonetaryAmountFactory.

Parameters:

query - the factory query, not null.

Returns:

true, if at least one MonetaryAmountFactory matches the query.

getCurrency

public static CurrencyUnit getCurrency(String currencyCode,
 String... providers)

Access a new instance based on the currency code. Currencies are available as provided by CurrencyProviderSpi instances registered with the Bootstrap.

Parameters:

currencyCode - the ISO currency code, not null.

providers - the (optional) specification of providers to consider.

Returns:

the corresponding CurrencyUnit instance.

Throws:

UnknownCurrencyException - if no such currency exists.

getCurrency

public static CurrencyUnit getCurrency(Locale locale,
 String... providers)

Access a new instance based on the Locale. Currencies are available as provided by CurrencyProviderSpi instances registered with the Bootstrap.

Parameters:

locale - the target Locale, typically representing an ISO country, not null.

providers - the (optional) specification of providers to consider.

Returns:

the corresponding CurrencyUnit instance.

Throws:

UnknownCurrencyException - if no such currency exists.

getCurrencies

public static Set<CurrencyUnit> getCurrencies(Locale locale,
 String... providers)

Access a new instance based on the Locale. Currencies are available as provided by CurrencyProviderSpi instances registered with the Bootstrap.

Parameters:

locale - the target Locale, typically representing an ISO country, not null.

providers - the (optional) specification of providers to consider.

Returns:

the corresponding CurrencyUnit instance.

Throws:

UnknownCurrencyException - if no such currency exists.

isCurrencyAvailable

public static boolean isCurrencyAvailable(String code,
 String... providers)

Allows to check if a CurrencyUnit instance is defined, i.e. accessible from getCurrency(String, String...).

Parameters:

code - the currency code, not null.

providers - the (optional) specification of providers to consider.

Returns:

true if getCurrency(String, java.lang.String...) would return a result for the given code.

isCurrencyAvailable

public static boolean isCurrencyAvailable(Locale locale,
 String... providers)

Allows to check if a CurrencyUnit instance is defined, i.e. accessible from getCurrency(String, String...).

Parameters:

locale - the target Locale, not null.

providers - the (optional) specification of providers to consider.

Returns:

true if getCurrencies(Locale, String...) would return a result containing a currency with the given code.

getCurrencies

public static Collection<CurrencyUnit> getCurrencies(String... providers)

Access all currencies known.

Parameters:

providers - the (optional) specification of providers to consider.

Returns:

the list of known currencies, never null.

getCurrency

public static CurrencyUnit getCurrency(CurrencyQuery query)

Query all currencies matching the given query.

Parameters:

query - The CurrencyQuery, not null.

Returns:

the list of known currencies, never null.

getCurrencies

public static Collection<CurrencyUnit> getCurrencies(CurrencyQuery query)

Query all currencies matching the given query.

Parameters:

query - The CurrencyQuery, not null.

Returns:

the list of known currencies, never null.

getCurrencyProviderNames

public static Set<String> getCurrencyProviderNames()

Query all currencies matching the given query.

Returns:

the list of known currencies, never null.

getDefaultCurrencyProviderChain

public static List<String> getDefaultCurrencyProviderChain()

Query the list and ordering of provider names modelling the default provider chain to be used, if no provider chain was explicitly set..

Returns:

the ordered list provider names, modelling the default provider chain used, never null.