org.javamoney.moneta.spi.base

Class BaseMonetaryFormatsSingletonSpi

java.lang.Object

org.javamoney.moneta.spi.base.BaseMonetaryFormatsSingletonSpi

All Implemented Interfaces:

MonetaryFormatsSingletonSpi

public abstract class BaseMonetaryFormatsSingletonSpi
extends Object
implements MonetaryFormatsSingletonSpi

This interface models the singleton functionality of MonetaryFormats. Implementations of this interface must be thread-safe.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
BaseMonetaryFormatsSingletonSpi()

Method Summary

Modifier and Type	Method and Description
MonetaryAmountFormat	getAmountFormat(AmountFormatQuery formatQuery) Access an MonetaryAmountFormat given a .AmountFormatQuery.
MonetaryAmountFormat	getAmountFormat(Locale locale, String... providers) Access the default MonetaryAmountFormat given a Locale.
MonetaryAmountFormat	getAmountFormat(String formatName, String... providers) Access the default MonetaryAmountFormat given a Locale.
boolean	isAvailable(AmountFormatQuery formatQuery) Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
boolean	isAvailable(Locale locale, String... providers) Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.money.spi.MonetaryFormatsSingletonSpi

getAmountFormats, getAvailableLocales, getDefaultProviderChain, getProviderNames

Constructor Detail

BaseMonetaryFormatsSingletonSpi

public BaseMonetaryFormatsSingletonSpi()

Method Detail

getAmountFormat

public MonetaryAmountFormat getAmountFormat(AmountFormatQuery formatQuery)

Access an MonetaryAmountFormat given a .AmountFormatQuery.

Specified by:

getAmountFormat in interface MonetaryFormatsSingletonSpi

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

public boolean isAvailable(AmountFormatQuery formatQuery)

Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Specified by:

isAvailable in interface MonetaryFormatsSingletonSpi

Parameters:

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

Returns:

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

isAvailable

public boolean isAvailable(Locale locale,
                           String... providers)

Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.

Specified by:

isAvailable in interface MonetaryFormatsSingletonSpi

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

public MonetaryAmountFormat getAmountFormat(Locale locale,
                                            String... providers)

Access the default MonetaryAmountFormat given a Locale.

Specified by:

getAmountFormat in interface MonetaryFormatsSingletonSpi

Parameters:

locale - the target Locale, not null.

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

Returns:

the matching MonetaryAmountFormat

Throws:

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

getAmountFormat

public MonetaryAmountFormat getAmountFormat(String formatName,
                                            String... providers)

Access the default MonetaryAmountFormat given a Locale.

Specified by:

getAmountFormat in interface MonetaryFormatsSingletonSpi

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.