javax.money.format.MonetaryFormats Maven / Gradle / Ivy
Show all versions of money-api-bp Show documentation
/*
* CREDIT SUISSE IS WILLING TO LICENSE THIS SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT YOU
* ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE TERMS AND CONDITIONS OF THIS
* AGREEMENT CAREFULLY. BY DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE TERMS AND CONDITIONS OF
* THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY IT, SELECT THE "DECLINE" BUTTON AT THE
* BOTTOM OF THIS PAGE. Specification: JSR-354 Money and Currency API ("Specification") Copyright
* (c) 2012-2013, Credit Suisse All rights reserved.
*/
package javax.money.format;
import javax.money.MonetaryException;
import javax.money.spi.Bootstrap;
import javax.money.spi.MonetaryAmountFormatProviderSpi;
import javax.money.spi.MonetaryFormatsSingletonSpi;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* This class models the singleton accessor for {@link MonetaryAmountFormat} instances.
*
* This class is thread-safe.
*
* @author Anatole Tresch
* @author Werner Keil
*/
public final class MonetaryFormats {
private static final MonetaryFormatsSingletonSpi monetaryFormatsSingletonSpi = loadMonetaryFormatsSingletonSpi();
/**
* Private singleton constructor.
*/
private MonetaryFormats() {
// Singleton
}
/**
* Loads the SPI backing bean.
*
* @return the instance of MonetaryFormatsSingletonSpi to be used by this singleton.
*/
private static MonetaryFormatsSingletonSpi loadMonetaryFormatsSingletonSpi() {
try {
MonetaryFormatsSingletonSpi spi = Bootstrap.getService(MonetaryFormatsSingletonSpi.class);
if(spi==null){
spi = new DefaultMonetaryFormatsSingletonSpi();
}
return spi;
} catch (Exception e) {
Logger.getLogger(MonetaryFormats.class.getName())
.log(Level.WARNING, "Failed to load MonetaryFormatsSingletonSpi, using default.", e);
return new DefaultMonetaryFormatsSingletonSpi();
}
}
/**
* Checks if a {@link MonetaryAmountFormat} is available for the given {@link java.util.Locale} and providers.
*
* @param locale the target {@link java.util.Locale}, not {@code null}.
* @param providers The providers to be queried, if not set the providers as defined by #getDefaultRoundingProviderChain()
* are queried.
* @return true, if a corresponding {@link MonetaryAmountFormat} is accessible.
*/
public static boolean isAvailable(Locale locale, String... providers) {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.isAvailable(locale, providers);
}
/**
* Access the default {@link MonetaryAmountFormat} given a {@link java.util.Locale}.
*
* @param locale the target {@link java.util.Locale}, not {@code null}.
* @param providers The providers to be queried, if not set the providers as defined by #getDefaultRoundingProviderChain()
* are queried.
* @return the matching {@link MonetaryAmountFormat}
* @throws MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public static MonetaryAmountFormat getAmountFormat(Locale locale, String... providers) {
return getAmountFormat(AmountFormatQueryBuilder.of(locale).setProviderNames(providers).setLocale(locale).build());
}
/**
* Checks if a {@link MonetaryAmountFormat} is available for the given {@link AmountFormatQuery}.
*
* @param formatQuery the required {@link AmountFormatQuery}, not {@code null}. If the query does not define
* any explicit provider chain, the providers as defined by #getDefaultRoundingProviderChain()
* are used.
* @return true, if a corresponding {@link MonetaryAmountFormat} is accessible.
*/
public static boolean isAvailable(AmountFormatQuery formatQuery) {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.isAvailable(formatQuery);
}
/**
* Access the default {@link MonetaryAmountFormat} given a {@link java.util.Locale}.
*
* @param formatQuery the required {@link AmountFormatQuery}, not {@code null}. If the query does not define
* any explicit provider chain, the providers as defined by #getDefaultRoundingProviderChain()
* are used.
* @return the matching {@link MonetaryAmountFormat}
* @throws MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public static MonetaryAmountFormat getAmountFormat(AmountFormatQuery formatQuery) {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.getAmountFormat(formatQuery);
}
/**
* Access all {@link MonetaryAmountFormat} instances that match the given a {@link AmountFormatQuery}.
*
* @param formatQuery the required {@link AmountFormatQuery}, not {@code null}. If the query does not define
* any explicit provider chain, the providers as defined by #getDefaultRoundingProviderChain()
* are used.
* @return the matching {@link MonetaryAmountFormat}
* @throws MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public static Collection getAmountFormats(AmountFormatQuery formatQuery) {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.getAmountFormats(formatQuery);
}
/**
* Access the a {@link MonetaryAmountFormat} given its styleId.
*
* @param formatName the target format name, not {@code null}.
* @param providers The providers to be used, if not set the providers as defined by #getDefaultRoundingProviderChain() are
* used.
* @return the matching {@link MonetaryAmountFormat}
* @throws MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public static MonetaryAmountFormat getAmountFormat(String formatName, String... providers) {
return getAmountFormat(AmountFormatQueryBuilder.of(formatName).setProviderNames(providers).build());
}
/**
* Get all available locales. This equals to {@link javax.money.spi.MonetaryAmountFormatProviderSpi#getAvailableLocales()}.
*
* @param providers The providers to be used, if not set the providers as defined by #getDefaultRoundingProviderChain() are
* used.
* @return all available locales, never {@code null}.
*/
public static Set getAvailableLocales(String... providers) {
return monetaryFormatsSingletonSpi.getAvailableLocales(providers);
}
/**
* Get the names of the currently registered format providers.
*
* @return the provider names, never null.
*/
public static Collection getFormatProviderNames() {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.getProviderNames();
}
/**
* Get the default provider chain, identified by the unique provider names in order as evaluated and used.
*
* @return the default provider chain, never null.
*/
public static List getDefaultFormatProviderChain() {
if(monetaryFormatsSingletonSpi==null){
throw new MonetaryException(
"No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
}
return monetaryFormatsSingletonSpi.getDefaultProviderChain();
}
/**
* This class models the singleton accessor for {@link MonetaryAmountFormat} instances.
*
* This class is thread-safe.
*
* @author Anatole Tresch
* @author Werner Keil
*/
public static final class DefaultMonetaryFormatsSingletonSpi implements MonetaryFormatsSingletonSpi {
/**
* Access an {@link MonetaryAmountFormat} given a {@link javax.money.format
* .AmountFormatContext}.
*
* @param formatQuery The format query defining the requirements of the formatter.
* @return the corresponding {@link MonetaryAmountFormat}
* @throws javax.money.MonetaryException if no registered {@link javax.money.spi
* .MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public Collection getAmountFormats(AmountFormatQuery formatQuery) {
Collection result = new ArrayList();
for (MonetaryAmountFormatProviderSpi spi : Bootstrap.getServices(MonetaryAmountFormatProviderSpi.class)) {
Collection formats = spi.getAmountFormats(formatQuery);
if (formats!=null) {
result.addAll(formats);
}
}
return result;
}
@Override
public Set getProviderNames() {
return getSpisAsMap().keySet();
}
/**
* This default implementation simply returns all providers defined in arbitrary order.
*
* @return the default provider chain, never null.
*/
@Override
public List getDefaultProviderChain() {
List list = new ArrayList();
list.addAll(getProviderNames());
Collections.sort(list);
return list;
}
/**
* Get all available locales. This equals to {@link javax.money.spi
* .MonetaryAmountFormatProviderSpi#getAvailableLocales()}.
*
* @return all available locales, never {@code null}.
*/
public Set getAvailableLocales(String... providerNames) {
Set locales = new HashSet();
Collection spis = getSpis(providerNames);
for (MonetaryAmountFormatProviderSpi spi : spis) {
locales.addAll(spi.getAvailableLocales());
}
return locales;
}
private Map getSpisAsMap() {
Map spis = new ConcurrentHashMap();
for (MonetaryAmountFormatProviderSpi spi : Bootstrap.getServices(MonetaryAmountFormatProviderSpi.class)) {
if (spi.getProviderName() == null) {
Logger.getLogger(MonetaryFormats.class.getName()).warning("MonetaryAmountFormatProviderSpi " +
"returns null for " +
"getProviderName: " +
spi.getClass().getName());
}
spis.put(spi.getProviderName(), spi);
}
return spis;
}
private Collection getSpis(String... providerNames) {
List providers = new ArrayList();
Map spis = getSpisAsMap();
if (providerNames.length == 0) {
providers.addAll(spis.values());
} else {
for (String provName : providerNames) {
MonetaryAmountFormatProviderSpi spi = spis.get(provName);
if (spi==null) {
throw new IllegalArgumentException("MonetaryAmountFormatProviderSpi not found: " + provName);
}
providers.add(spi);
}
}
return providers;
}
/**
* Access an {@link MonetaryAmountFormat} given a {@link javax.money.format
* .AmountFormatQuery}.
*
* @param formatQuery The format query defining the requirements of the formatter.
* @return the corresponding {@link MonetaryAmountFormat}
* @throws javax.money.MonetaryException if no registered {@link javax.money.spi
* .MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public MonetaryAmountFormat getAmountFormat(AmountFormatQuery formatQuery) {
Collection formats = getAmountFormats(formatQuery);
if (formats.isEmpty()) {
throw new MonetaryException("No MonetaryAmountFormat for AmountFormatQuery " + formatQuery);
}
return formats.iterator().next();
}
/**
* Checks if a {@link MonetaryAmountFormat} is available given a {@link javax.money.format
* .AmountFormatQuery}.
*
* @param formatQuery The format query defining the requirements of the formatter.
* @return true, if a t least one {@link MonetaryAmountFormat} is matching the query.
*/
public boolean isAvailable(AmountFormatQuery formatQuery) {
return !getAmountFormats(formatQuery).isEmpty();
}
/**
* Checks if a {@link MonetaryAmountFormat} is available given a {@link javax.money.format
* .AmountFormatQuery}.
*
* @param locale the target {@link java.util.Locale}, not {@code null}.
* @param providers The (optional) providers to be used, oredered correspondingly.
* @return true, if a t least one {@link MonetaryAmountFormat} is matching the query.
*/
public boolean isAvailable(Locale locale, String... providers) {
return isAvailable(AmountFormatQuery.of(locale, providers));
}
/**
* Access the default {@link MonetaryAmountFormat} given a {@link java.util.Locale}.
*
* @param locale the target {@link java.util.Locale}, not {@code null}.
* @param providers The (optional) providers to be used, oredered correspondingly.
* @return the matching {@link MonetaryAmountFormat}
* @throws javax.money.MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public MonetaryAmountFormat getAmountFormat(Locale locale, String... providers) {
return getAmountFormat(AmountFormatQueryBuilder.of(locale).setProviderNames(providers).build());
}
/**
* Access the default {@link MonetaryAmountFormat} given a {@link java.util.Locale}.
*
* @param formatName the target format name, not {@code null}.
* @param providers The (optional) providers to be used, oredered correspondingly.
* @return the matching {@link MonetaryAmountFormat}
* @throws javax.money.MonetaryException if no registered {@link javax.money.spi.MonetaryAmountFormatProviderSpi} can provide a
* corresponding {@link MonetaryAmountFormat} instance.
*/
public MonetaryAmountFormat getAmountFormat(String formatName, String... providers) {
return getAmountFormat(AmountFormatQueryBuilder.of(formatName).setProviderNames(providers).build());
}
}
}