Module java.money

Package javax.money.spi

Interface MonetaryAmountFormatProviderSpi

public interface MonetaryAmountFormatProviderSpi

SPI (formatting) providing MonetaryAmountFormat instances.

Author:

Anatole Tresch

Method Summary

Modifier and Type	Method	Description
java.util.Collection<MonetaryAmountFormat>	getAmountFormats(AmountFormatQuery formatQuery)	Create a new MonetaryAmountFormat for the given input.
java.util.Set<java.lang.String>	getAvailableFormatNames()	Gets a list with available format names for this format provider.
java.util.Set<java.util.Locale>	getAvailableLocales()	Gets a list with available locales for this format provider.
default java.lang.String	getProviderName()	Access the provider's name.

Method Detail

getProviderName

default java.lang.String getProviderName()

Access the provider's name.

Returns:

this provider's name, not null.

getAmountFormats

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

Create a new MonetaryAmountFormat for the given input.

Parameters:

formatQuery - The AmountFormatContext to be used.

Returns:

An according MonetaryAmountFormat instance, or null, which delegates the request to subsequent MonetaryAmountFormatProviderSpi instances registered.

getAvailableLocales

java.util.Set<java.util.Locale> getAvailableLocales()

Gets a list with available locales for this format provider.

Returns:

list of available locales, never null.

getAvailableFormatNames

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

Gets a list with available format names for this format provider.

Returns:

list of available formats, never null.