Top Description Methods
javax.money.spi

public Interface CurrencyProviderSpi

Imports
javax.money.CurrencyQuery, .CurrencyUnit, java.util.Set
SPI (core) to be registered using the javax.money.spi.Bootstrap, which allows to register/provide additional currencies into the system automatically on startup. The implementation is allowed to be implemented in y contextual way, so depending on the runtime context, different currencies may be available.
Author
Anatole Tresch

Method Summary

Modifier and TypeMethod and Description
public Set<CurrencyUnit>

Returns:

the corresponding CurrencyUnits matching, never null.
getCurrencies(CurrencyQuery
the javax.money.CurrencyQuery containing the parameters determining the query. not null.
query)

Return a CurrencyUnit instances matching the given javax.money.CurrencyContext.

public default String

Returns:

the unique provider id, never null or empty.
getProviderName()

The unique name of this currency provider instance.

public default boolean

Returns:

false, if no such unit is provided by this provider.
isCurrencyAvailable(CurrencyQuery
the javax.money.CurrencyQuery containing the parameters determining the query. not null.
query)

Checks if a CurrencyUnit instances matching the given javax.money.CurrencyContext is available from this provider.

Method Detail

getCurrenciesback to summary
public Set<CurrencyUnit> getCurrencies(CurrencyQuery query)

Return a CurrencyUnit instances matching the given javax.money.CurrencyContext.

Parameters
query:CurrencyQuery

the javax.money.CurrencyQuery containing the parameters determining the query. not null.

Returns:Set<CurrencyUnit>

the corresponding CurrencyUnits matching, never null.

getProviderNameback to summary
public default String getProviderName()

The unique name of this currency provider instance.

Returns:String

the unique provider id, never null or empty.

isCurrencyAvailableback to summary
public default boolean isCurrencyAvailable(CurrencyQuery query)

Checks if a CurrencyUnit instances matching the given javax.money.CurrencyContext is available from this provider.

Parameters
query:CurrencyQuery

the javax.money.CurrencyQuery containing the parameters determining the query. not null.

Returns:boolean

false, if no such unit is provided by this provider.