LocaleServiceProviderPool.java revision 0
0N/A/*
0N/A * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Sun designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Sun in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
0N/A * CA 95054 USA or visit www.sun.com if you need additional information or
0N/A * have any questions.
0N/A */
0N/A
0N/Apackage sun.util;
0N/A
0N/Aimport java.security.AccessController;
0N/Aimport java.security.PrivilegedActionException;
0N/Aimport java.security.PrivilegedExceptionAction;
0N/Aimport java.util.Arrays;
0N/Aimport java.util.HashSet;
0N/Aimport java.util.Iterator;
0N/Aimport java.util.LinkedHashSet;
0N/Aimport java.util.List;
0N/Aimport java.util.Locale;
0N/Aimport java.util.Map;
0N/Aimport java.util.ServiceLoader;
0N/Aimport java.util.ServiceConfigurationError;
0N/Aimport java.util.Set;
0N/Aimport java.util.concurrent.ConcurrentHashMap;
0N/Aimport java.util.logging.Logger;
0N/Aimport java.util.spi.LocaleServiceProvider;
0N/Aimport sun.util.resources.LocaleData;
0N/Aimport sun.util.resources.OpenListResourceBundle;
0N/A
0N/A/**
0N/A * An instance of this class holds a set of the third party implementations of a particular
0N/A * locale sensitive service, such as {@link java.util.spi.LocaleNameProvider}.
0N/A *
0N/A */
0N/Apublic final class LocaleServiceProviderPool {
0N/A
0N/A /**
0N/A * A Map that holds singleton instances of this class. Each instance holds a
0N/A * set of provider implementations of a particular locale sensitive service.
0N/A */
0N/A private static Map<Class, LocaleServiceProviderPool> poolOfPools =
0N/A new ConcurrentHashMap<Class, LocaleServiceProviderPool>();
0N/A
0N/A /**
0N/A * A Set containing locale service providers that implement the
0N/A * specified provider SPI
0N/A */
0N/A private Set<LocaleServiceProvider> providers =
0N/A new LinkedHashSet<LocaleServiceProvider>();
0N/A
0N/A /**
0N/A * A Map that retains Locale->provider mapping
0N/A */
0N/A private Map<Locale, LocaleServiceProvider> providersCache =
0N/A new ConcurrentHashMap<Locale, LocaleServiceProvider>();
0N/A
0N/A /**
0N/A * Available locales for this locale sensitive service. This also contains
0N/A * JRE's available locales
0N/A */
0N/A private Set<Locale> availableLocales = null;
0N/A
0N/A /**
0N/A * Available locales within this JRE. Currently this is declared as
0N/A * static. This could be non-static later, so that they could have
0N/A * different sets for each locale sensitive services.
0N/A */
0N/A private static List<Locale> availableJRELocales = null;
0N/A
0N/A /**
0N/A * Provider locales for this locale sensitive service.
0N/A */
0N/A private Set<Locale> providerLocales = null;
0N/A
0N/A /**
0N/A * A factory method that returns a singleton instance
0N/A */
0N/A public static LocaleServiceProviderPool getPool(Class<? extends LocaleServiceProvider> providerClass) {
0N/A LocaleServiceProviderPool pool = poolOfPools.get(providerClass);
0N/A if (pool == null) {
0N/A LocaleServiceProviderPool newPool =
0N/A new LocaleServiceProviderPool(providerClass);
0N/A pool = poolOfPools.put(providerClass, newPool);
0N/A if (pool == null) {
0N/A pool = newPool;
0N/A }
0N/A }
0N/A
0N/A return pool;
0N/A }
0N/A
0N/A /**
0N/A * The sole constructor.
0N/A *
0N/A * @param c class of the locale sensitive service
0N/A */
0N/A private LocaleServiceProviderPool (final Class<? extends LocaleServiceProvider> c) {
0N/A try {
0N/A AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {
0N/A public Object run() {
0N/A for (LocaleServiceProvider provider : ServiceLoader.loadInstalled(c)) {
0N/A providers.add(provider);
0N/A }
0N/A return null;
0N/A }
0N/A });
0N/A } catch (PrivilegedActionException e) {
0N/A Logger.getLogger("sun.util.LocaleServiceProviderPool").config(e.toString());
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Lazy loaded set of available locales.
0N/A * Loading all locales is a very long operation.
0N/A */
0N/A private static class AllAvailableLocales {
0N/A /**
0N/A * Available locales for all locale sensitive services.
0N/A * This also contains JRE's available locales
0N/A */
0N/A static final Locale[] allAvailableLocales;
0N/A
0N/A static {
0N/A Class[] providerClasses = {
0N/A java.text.spi.BreakIteratorProvider.class,
0N/A java.text.spi.CollatorProvider.class,
0N/A java.text.spi.DateFormatProvider.class,
0N/A java.text.spi.DateFormatSymbolsProvider.class,
0N/A java.text.spi.DecimalFormatSymbolsProvider.class,
0N/A java.text.spi.NumberFormatProvider.class,
0N/A java.util.spi.CurrencyNameProvider.class,
0N/A java.util.spi.LocaleNameProvider.class,
0N/A java.util.spi.TimeZoneNameProvider.class };
0N/A Set<Locale> all = new HashSet<Locale>(Arrays.asList(
0N/A LocaleData.getAvailableLocales())
0N/A );
0N/A for (Class providerClass : providerClasses) {
0N/A LocaleServiceProviderPool pool =
0N/A LocaleServiceProviderPool.getPool(providerClass);
0N/A all.addAll(pool.getProviderLocales());
0N/A }
0N/A allAvailableLocales = all.toArray(new Locale[0]);
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Returns an array of available locales for all the provider classes.
0N/A * This array is a merged array of all the locales that are provided by each
0N/A * provider, including the JRE.
0N/A *
0N/A * @return an array of the available locales for all provider classes
0N/A */
0N/A public static Locale[] getAllAvailableLocales() {
0N/A return AllAvailableLocales.allAvailableLocales.clone();
0N/A }
0N/A
0N/A /**
0N/A * Returns an array of available locales. This array is a
0N/A * merged array of all the locales that are provided by each
0N/A * provider, including the JRE.
0N/A *
0N/A * @return an array of the available locales
0N/A */
0N/A public synchronized Locale[] getAvailableLocales() {
0N/A if (availableLocales == null) {
0N/A availableLocales = new HashSet<Locale>(getJRELocales());
0N/A if (hasProviders()) {
0N/A availableLocales.addAll(getProviderLocales());
0N/A }
0N/A }
0N/A Locale[] tmp = new Locale[availableLocales.size()];
0N/A availableLocales.toArray(tmp);
0N/A return tmp;
0N/A }
0N/A
0N/A /**
0N/A * Returns an array of available locales from providers.
0N/A * Note that this method does not return a defensive copy.
0N/A *
0N/A * @return list of the provider locales
0N/A */
0N/A private synchronized Set<Locale> getProviderLocales() {
0N/A if (providerLocales == null) {
0N/A providerLocales = new HashSet<Locale>();
0N/A if (hasProviders()) {
0N/A for (LocaleServiceProvider lsp : providers) {
0N/A Locale[] locales = lsp.getAvailableLocales();
0N/A for (Locale locale: locales) {
0N/A providerLocales.add(locale);
0N/A }
0N/A }
0N/A }
0N/A }
0N/A return providerLocales;
0N/A }
0N/A
0N/A /**
0N/A * Returns whether any provider for this locale sensitive
0N/A * service is available or not.
0N/A *
0N/A * @return true if any provider is available
0N/A */
0N/A public boolean hasProviders() {
0N/A return !providers.isEmpty();
0N/A }
0N/A
0N/A /**
0N/A * Returns an array of available locales supported by the JRE.
0N/A * Note that this method does not return a defensive copy.
0N/A *
0N/A * @return list of the available JRE locales
0N/A */
0N/A private synchronized List<Locale> getJRELocales() {
0N/A if (availableJRELocales == null) {
0N/A availableJRELocales =
0N/A Arrays.asList(LocaleData.getAvailableLocales());
0N/A }
0N/A return availableJRELocales;
0N/A }
0N/A
0N/A /**
0N/A * Returns whether the given locale is supported by the JRE.
0N/A *
0N/A * @param locale the locale to test.
0N/A * @return true, if the locale is supported by the JRE. false
0N/A * otherwise.
0N/A */
0N/A private boolean isJRESupported(Locale locale) {
0N/A List<Locale> locales = getJRELocales();
0N/A return locales.contains(locale);
0N/A }
0N/A
0N/A /**
0N/A * Returns the provider's localized object for the specified
0N/A * locale.
0N/A *
0N/A * @param getter an object on which getObject() method
0N/A * is called to obtain the provider's instance.
0N/A * @param locale the given locale that is used as the starting one
0N/A * @param params provider specific parameters
0N/A * @return provider's instance, or null.
0N/A */
0N/A public <P, S> S getLocalizedObject(LocalizedObjectGetter<P, S> getter,
0N/A Locale locale,
0N/A Object... params) {
0N/A return getLocalizedObjectImpl(getter, locale, true, null, null, null, params);
0N/A }
0N/A
0N/A /**
0N/A * Returns the provider's localized name for the specified
0N/A * locale.
0N/A *
0N/A * @param getter an object on which getObject() method
0N/A * is called to obtain the provider's instance.
0N/A * @param locale the given locale that is used as the starting one
0N/A * @param bundle JRE resource bundle that contains
0N/A * the localized names, or null for localized objects.
0N/A * @param key the key string if bundle is supplied, otherwise null.
0N/A * @param params provider specific parameters
0N/A * @return provider's instance, or null.
0N/A */
0N/A public <P, S> S getLocalizedObject(LocalizedObjectGetter<P, S> getter,
0N/A Locale locale,
0N/A OpenListResourceBundle bundle,
0N/A String key,
0N/A Object... params) {
0N/A return getLocalizedObjectImpl(getter, locale, false, null, bundle, key, params);
0N/A }
0N/A
0N/A /**
0N/A * Returns the provider's localized name for the specified
0N/A * locale.
0N/A *
0N/A * @param getter an object on which getObject() method
0N/A * is called to obtain the provider's instance.
0N/A * @param locale the given locale that is used as the starting one
0N/A * @param bundleKey JRE specific bundle key. e.g., "USD" is for currency
0N/A symbol and "usd" is for currency display name in the JRE bundle.
0N/A * @param bundle JRE resource bundle that contains
0N/A * the localized names, or null for localized objects.
0N/A * @param key the key string if bundle is supplied, otherwise null.
0N/A * @param params provider specific parameters
0N/A * @return provider's instance, or null.
0N/A */
0N/A public <P, S> S getLocalizedObject(LocalizedObjectGetter<P, S> getter,
0N/A Locale locale,
0N/A String bundleKey,
0N/A OpenListResourceBundle bundle,
0N/A String key,
0N/A Object... params) {
0N/A return getLocalizedObjectImpl(getter, locale, false, bundleKey, bundle, key, params);
0N/A }
0N/A
0N/A private <P, S> S getLocalizedObjectImpl(LocalizedObjectGetter<P, S> getter,
0N/A Locale locale,
0N/A boolean isObjectProvider,
0N/A String bundleKey,
0N/A OpenListResourceBundle bundle,
0N/A String key,
0N/A Object... params) {
0N/A if (hasProviders()) {
0N/A if (bundleKey == null) {
0N/A bundleKey = key;
0N/A }
0N/A Locale bundleLocale = (bundle != null ? bundle.getLocale() : null);
0N/A Locale requested = locale;
0N/A P lsp;
0N/A S providersObj = null;
0N/A
0N/A // check whether a provider has an implementation that's closer
0N/A // to the requested locale than the bundle we've found (for
0N/A // localized names), or Java runtime's supported locale
0N/A // (for localized objects)
0N/A while ((locale = findProviderLocale(locale, bundleLocale)) != null) {
0N/A
0N/A lsp = (P)findProvider(locale);
0N/A
0N/A if (lsp != null) {
0N/A providersObj = getter.getObject(lsp, requested, key, params);
0N/A if (providersObj != null) {
0N/A return providersObj;
0N/A } else if (isObjectProvider) {
0N/A Logger.getLogger("sun.util.LocaleServiceProviderPool").config(
0N/A "A locale sensitive service provider returned null for a localized objects, which should not happen. provider: " + lsp + " locale: " + requested);
0N/A }
0N/A }
0N/A
0N/A locale = getParentLocale(locale);
0N/A }
0N/A
0N/A // look up the JRE bundle and its parent chain. Only
0N/A // providers for localized names are checked hereafter.
0N/A while (bundle != null) {
0N/A bundleLocale = bundle.getLocale();
0N/A
0N/A if (bundle.handleGetKeys().contains(bundleKey)) {
0N/A // JRE has it.
0N/A return null;
0N/A } else {
0N/A lsp = (P)findProvider(bundleLocale);
0N/A if (lsp != null) {
0N/A providersObj = getter.getObject(lsp, requested, key, params);
0N/A if (providersObj != null) {
0N/A return providersObj;
0N/A }
0N/A }
0N/A }
0N/A
0N/A // try parent bundle
0N/A bundle = bundle.getParent();
0N/A }
0N/A }
0N/A
0N/A // not found.
0N/A return null;
0N/A }
0N/A
0N/A /**
0N/A * Returns a locale service provider instance that supports
0N/A * the specified locale.
0N/A *
0N/A * @param locale the given locale
0N/A * @return the provider, or null if there is
0N/A * no provider available.
0N/A */
0N/A private LocaleServiceProvider findProvider(Locale locale) {
0N/A if (!hasProviders()) {
0N/A return null;
0N/A }
0N/A
0N/A if (providersCache.containsKey(locale)) {
0N/A LocaleServiceProvider provider = providersCache.get(locale);
0N/A if (provider != NullProvider.INSTANCE) {
0N/A return provider;
0N/A }
0N/A } else {
0N/A for (LocaleServiceProvider lsp : providers) {
0N/A Locale[] locales = lsp.getAvailableLocales();
0N/A for (Locale available: locales) {
0N/A if (locale.equals(available)) {
0N/A LocaleServiceProvider providerInCache =
0N/A providersCache.put(locale, lsp);
0N/A return (providerInCache != null ?
0N/A providerInCache :
0N/A lsp);
0N/A }
0N/A }
0N/A }
0N/A providersCache.put(locale, NullProvider.INSTANCE);
0N/A }
0N/A return null;
0N/A }
0N/A
0N/A /**
0N/A * Returns the provider's locale that is the most appropriate
0N/A * within the range
0N/A *
0N/A * @param start the given locale that is used as the starting one
0N/A * @param end the given locale that is used as the end one (exclusive),
0N/A * or null if it reaching any of the JRE supported locale should
0N/A * terminate the look up.
0N/A * @return the most specific locale within the range, or null
0N/A * if no provider locale found in that range.
0N/A */
0N/A private Locale findProviderLocale(Locale start, Locale end) {
0N/A Set<Locale> provLoc = getProviderLocales();
0N/A Locale current = start;
0N/A
0N/A while (current != null) {
0N/A if (end != null) {
0N/A if (current.equals(end)) {
0N/A current = null;
0N/A break;
0N/A }
0N/A } else {
0N/A if (isJRESupported(current)) {
0N/A current = null;
0N/A break;
0N/A }
0N/A }
0N/A
0N/A if (provLoc.contains(current)) {
0N/A break;
0N/A }
0N/A
0N/A current = getParentLocale(current);
0N/A }
0N/A
0N/A return current;
0N/A }
0N/A
0N/A /**
0N/A * Returns the parent locale.
0N/A *
0N/A * @param locale the locale
0N/A * @return the parent locale
0N/A */
0N/A private static Locale getParentLocale(Locale locale) {
0N/A String variant = locale.getVariant();
0N/A if (variant != "") {
0N/A int underscoreIndex = variant.lastIndexOf('_');
0N/A if (underscoreIndex != (-1)) {
0N/A return new Locale(locale.getLanguage(), locale.getCountry(),
0N/A variant.substring(0, underscoreIndex));
0N/A } else {
0N/A return new Locale(locale.getLanguage(), locale.getCountry());
0N/A }
0N/A } else if (locale.getCountry() != "") {
0N/A return new Locale(locale.getLanguage());
0N/A } else if (locale.getLanguage() != "") {
0N/A return Locale.ROOT;
0N/A } else {
0N/A return null;
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * A dummy locale service provider that indicates there is no
0N/A * provider available
0N/A */
0N/A private static class NullProvider extends LocaleServiceProvider {
0N/A private static final NullProvider INSTANCE = new NullProvider();
0N/A
0N/A public Locale[] getAvailableLocales() {
0N/A throw new RuntimeException("Should not get called.");
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * An interface to get a localized object for each locale sensitve
0N/A * service class.
0N/A */
0N/A public interface LocalizedObjectGetter<P, S> {
0N/A /**
0N/A * Returns an object from the provider
0N/A *
0N/A * @param lsp the provider
0N/A * @param locale the locale
0N/A * @param key key string to localize, or null if the provider is not
0N/A * a name provider
0N/A * @param params provider specific params
0N/A * @return localized object from the provider
0N/A */
0N/A public S getObject(P lsp,
0N/A Locale locale,
0N/A String key,
0N/A Object... params);
0N/A }
0N/A}