Module java.money

Package javax.money.format

Class MonetaryFormats

java.lang.Object

javax.money.format.MonetaryFormats

public final class MonetaryFormats
extends java.lang.Object

This class models the singleton accessor for MonetaryAmountFormat instances.

This class is thread-safe.

Author:

Anatole Tresch, Werner Keil

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MonetaryFormats.DefaultMonetaryFormatsSingletonSpi	This class models the singleton accessor for MonetaryAmountFormat instances.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

isAvailable

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

Checks if a MonetaryAmountFormat is available for the given Locale and providers.

Parameters:

locale - the target Locale, not null.

providers - The providers to be queried, if not set the providers as defined by #getDefaultCurrencyProviderChain() are queried.

Returns:

true, if a corresponding MonetaryAmountFormat is accessible.

getAmountFormat

public static 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 providers to be queried, if not set the providers as defined by #getDefaultCurrencyProviderChain() are queried.

Returns:

the matching MonetaryAmountFormat

Throws:

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

isAvailable

public static boolean isAvailable(AmountFormatQuery formatQuery)

Checks if a MonetaryAmountFormat is available for the given AmountFormatQuery.

Parameters:

formatQuery - the required AmountFormatQuery, not null. If the query does not define any explicit provider chain, the providers as defined by #getDefaultCurrencyProviderChain() are used.

Returns:

true, if a corresponding MonetaryAmountFormat is accessible.

getAmountFormat

public static MonetaryAmountFormat getAmountFormat(AmountFormatQuery formatQuery)

Access the default MonetaryAmountFormat given a Locale.

Parameters:

formatQuery - the required AmountFormatQuery, not null. If the query does not define any explicit provider chain, the providers as defined by #getDefaultCurrencyProviderChain() are used.

Returns:

the matching MonetaryAmountFormat

Throws:

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

getAmountFormats

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

Access all MonetaryAmountFormat instances that match the given a AmountFormatQuery.

Parameters:

formatQuery - the required AmountFormatQuery, not null. If the query does not define any explicit provider chain, the providers as defined by #getDefaultCurrencyProviderChain() are used.

Returns:

the matching MonetaryAmountFormat

Throws:

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

getAmountFormat

public static MonetaryAmountFormat getAmountFormat(java.lang.String formatName,
                                                   java.lang.String... providers)

Access the a MonetaryAmountFormat given its styleId.

Parameters:

formatName - the target format name, not null.

providers - The providers to be used, if not set the providers as defined by #getDefaultCurrencyProviderChain() are used.

Returns:

the matching MonetaryAmountFormat

Throws:

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

getAvailableLocales

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

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

Parameters:

providers - The providers to be used, if not set the providers as defined by #getDefaultCurrencyProviderChain() are used.

Returns:

all available locales, never null.

getFormatProviderNames

public static java.util.Collection<java.lang.String> getFormatProviderNames()

Get the names of the currently registered format providers.

Returns:

the provider names, never null.

getDefaultFormatProviderChain

public static java.util.List<java.lang.String> getDefaultFormatProviderChain()

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

Returns:

the default provider chain, never null.