Module java.money

Package javax.money.spi

Interface MonetaryFormatsSingletonSpi

All Known Implementing Classes:

MonetaryFormats.DefaultMonetaryFormatsSingletonSpi

public interface MonetaryFormatsSingletonSpi

This interface models the singleton functionality of MonetaryFormats.

Implementations of this interface must be thread-safe.

Author:

Anatole Tresch, Werner Keil

Method Summary

Modifier and Type	Method	Description
default MonetaryAmountFormat	getAmountFormat(java.lang.String formatName, java.lang.String... providers)	Access the default MonetaryAmountFormat given a Locale.
default MonetaryAmountFormat	getAmountFormat(java.util.Locale locale, java.lang.String... providers)	Access the default MonetaryAmountFormat given a Locale.
default MonetaryAmountFormat	getAmountFormat(AmountFormatQuery formatQuery)	Access an MonetaryAmountFormat given a .AmountFormatQuery.
java.util.Collection<MonetaryAmountFormat>	getAmountFormats(AmountFormatQuery formatQuery)	Access all MonetaryAmountFormat instances matching the given .AmountFormatQuery.
java.util.Set<java.util.Locale>	getAvailableLocales(java.lang.String... providers)	Get all available locales.
java.util.List<java.lang.String>	getDefaultProviderChain()	Get the default provider chain, identified by the unique provider names in order as evaluated and used.
java.util.Set<java.lang.String>	getProviderNames()	Get the names of the currently registered format providers.
default boolean	isAvailable(java.util.Locale locale, java.lang.String... providers)	Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
default boolean	isAvailable(AmountFormatQuery formatQuery)	Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Method Detail

getAvailableLocales

java.util.Set<java.util.Locale> getAvailableLocales(java.lang.String... providers)

Get all available locales. This equals to MonetaryAmountFormatProviderSpi.getAvailableLocales().

Parameters:

providers - The (optional) providers to be used, ordered correspondingly.

Returns:

all available locales, never null.

getAmountFormats

java.util.Collection<MonetaryAmountFormat> getAmountFormats(AmountFormatQuery formatQuery)

Access all MonetaryAmountFormat instances matching the given .AmountFormatQuery.

Parameters:

formatQuery - The format query defining the requirements of the formatter.

Returns:

the corresponding MonetaryAmountFormat instances, never null

getProviderNames

java.util.Set<java.lang.String> getProviderNames()

Get the names of the currently registered format providers.

Returns:

the provider names, never null.

getDefaultProviderChain

java.util.List<java.lang.String> getDefaultProviderChain()

Get the default provider chain, identified by the unique provider names in order as evaluated and used.

Returns:

the default provider chain, never null.

getAmountFormat

default MonetaryAmountFormat getAmountFormat(AmountFormatQuery formatQuery)

Access an MonetaryAmountFormat given a .AmountFormatQuery.

Parameters:

formatQuery - The format query defining the requirements of the formatter.

Returns:

the corresponding MonetaryAmountFormat

Throws:

MonetaryException - if no registered .MonetaryAmountFormatProviderSpi can provide a corresponding MonetaryAmountFormat instance.

isAvailable

default boolean isAvailable(AmountFormatQuery formatQuery)

Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Parameters:

formatQuery - The format query defining the requirements of the formatter.

Returns:

true, if a t least one MonetaryAmountFormat is matching the query.

isAvailable

default boolean isAvailable(java.util.Locale locale,
                            java.lang.String... providers)

Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Parameters:

locale - the target Locale, not null.

providers - The (optional) providers to be used, ordered correspondingly.

Returns:

true, if a t least one MonetaryAmountFormat is matching the query.

getAmountFormat

default MonetaryAmountFormat getAmountFormat(java.util.Locale locale,
                                             java.lang.String... providers)

Access the default MonetaryAmountFormat given a Locale.

Parameters:

locale - the target Locale, not null.

providers - The (optional) providers to be used, ordered correspondingly.

Returns:

the matching MonetaryAmountFormat

Throws:

MonetaryException - if no registered MonetaryAmountFormatProviderSpi can provide a corresponding MonetaryAmountFormat instance.

getAmountFormat

default MonetaryAmountFormat getAmountFormat(java.lang.String formatName,
                                             java.lang.String... providers)

Access the default MonetaryAmountFormat given a Locale.

Parameters:

formatName - the target format name, not null.

providers - The (optional) providers to be used, ordered correspondingly.

Returns:

the matching MonetaryAmountFormat

Throws:

MonetaryException - if no registered MonetaryAmountFormatProviderSpi can provide a corresponding MonetaryAmountFormat instance.