1 /*
2 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package sun.util.locale.provider;
27
28 import java.security.AccessController;
29 import java.text.spi.BreakIteratorProvider;
30 import java.text.spi.CollatorProvider;
31 import java.text.spi.DateFormatProvider;
32 import java.text.spi.DateFormatSymbolsProvider;
33 import java.text.spi.DecimalFormatSymbolsProvider;
34 import java.text.spi.NumberFormatProvider;
35 import java.util.ArrayList;
36 import java.util.Collections;
37 import java.util.List;
38 import java.util.Locale;
39 import java.util.ResourceBundle;
40 import java.util.Set;
41 import java.util.concurrent.ConcurrentHashMap;
42 import java.util.concurrent.ConcurrentMap;
43 import java.util.spi.CalendarDataProvider;
44 import java.util.spi.CalendarNameProvider;
45 import java.util.spi.CurrencyNameProvider;
46 import java.util.spi.LocaleNameProvider;
47 import java.util.spi.LocaleServiceProvider;
48 import java.util.spi.TimeZoneNameProvider;
49 import sun.util.cldr.CLDRLocaleProviderAdapter;
50 import sun.util.spi.CalendarProvider;
51
52 /**
53 * The LocaleProviderAdapter abstract class.
54 *
55 * @author Naoto Sato
56 * @author Masayoshi Okutsu
57 */
58 public abstract class LocaleProviderAdapter {
59 /**
60 * Adapter type.
61 */
62 public static enum Type {
63 JRE("sun.util.resources", "sun.text.resources"),
64 CLDR("sun.util.resources.cldr", "sun.text.resources.cldr"),
65 SPI,
66 HOST,
67 FALLBACK("sun.util.resources", "sun.text.resources");
68
69 private final String UTIL_RESOURCES_PACKAGE;
70 private final String TEXT_RESOURCES_PACKAGE;
71
72 private Type() {
73 this(null, null);
74 }
75
76 private Type(String util, String text) {
77 UTIL_RESOURCES_PACKAGE = util;
78 TEXT_RESOURCES_PACKAGE = text;
79 }
80
81 public String getUtilResourcesPackage() {
82 return UTIL_RESOURCES_PACKAGE;
83 }
84
85 public String getTextResourcesPackage() {
86 return TEXT_RESOURCES_PACKAGE;
87 }
88 }
89
90 /**
91 * LocaleProviderAdapter preference list. The default list is intended
92 * to behave the same manner in JDK7.
93 */
94 private static final List<Type> adapterPreference;
95
96 /**
97 * JRE Locale Data Adapter instance
98 */
99 private static LocaleProviderAdapter jreLocaleProviderAdapter = new JRELocaleProviderAdapter();
100
101 /**
102 * SPI Locale Data Adapter instance
103 */
104 private static LocaleProviderAdapter spiLocaleProviderAdapter = new SPILocaleProviderAdapter();
105
106 /**
107 * CLDR Locale Data Adapter instance, if any.
108 */
109 private static LocaleProviderAdapter cldrLocaleProviderAdapter = null;
110
111 /**
112 * HOST Locale Data Adapter instance, if any.
113 */
114 private static LocaleProviderAdapter hostLocaleProviderAdapter = null;
115
116 /**
117 * FALLBACK Locale Data Adapter instance. It's basically the same with JRE, but only kicks
118 * in for the root locale.
119 */
120 private static LocaleProviderAdapter fallbackLocaleProviderAdapter = null;
121
122 /**
123 * Adapter lookup cache.
124 */
125 private static ConcurrentMap<Class<? extends LocaleServiceProvider>, ConcurrentMap<Locale, LocaleProviderAdapter>>
126 adapterCache = new ConcurrentHashMap<>();
127
128 static {
129 String order = AccessController.doPrivileged(
130 new sun.security.action.GetPropertyAction("java.locale.providers"));
131 List<Type> typeList = new ArrayList<>();
132
133 // Check user specified adapter preference
134 if (order != null && order.length() != 0) {
135 String[] types = order.split(",");
136 for (String type : types) {
137 try {
138 Type aType = Type.valueOf(type.trim().toUpperCase(Locale.ROOT));
139
140 // load adapter if necessary
141 switch (aType) {
142 case CLDR:
143 cldrLocaleProviderAdapter = new CLDRLocaleProviderAdapter();
144 break;
145 case HOST:
146 hostLocaleProviderAdapter = new HostLocaleProviderAdapter();
147 break;
148 }
149 typeList.add(aType);
150 } catch (IllegalArgumentException | UnsupportedOperationException e) {
151 // could be caused by the user specifying wrong
152 // provider name or format in the system property
153 LocaleServiceProviderPool.config(LocaleProviderAdapter.class, e.toString());
154 }
155 }
156 }
157
158 if (!typeList.isEmpty()) {
159 if (!typeList.contains(Type.JRE)) {
160 // Append FALLBACK as the last resort.
161 fallbackLocaleProviderAdapter = new FallbackLocaleProviderAdapter();
162 typeList.add(Type.FALLBACK);
163 }
164 } else {
165 // Default preference list
166 typeList.add(Type.JRE);
167 typeList.add(Type.SPI);
168 }
169
170 adapterPreference = Collections.unmodifiableList(typeList);
171 }
172
173 /**
174 * Returns the singleton instance for each adapter type
175 */
176 public static LocaleProviderAdapter forType(Type type) {
177 switch (type) {
178 case JRE:
179 return jreLocaleProviderAdapter;
180 case CLDR:
181 return cldrLocaleProviderAdapter;
182 case SPI:
183 return spiLocaleProviderAdapter;
184 case HOST:
185 return hostLocaleProviderAdapter;
186 case FALLBACK:
187 return fallbackLocaleProviderAdapter;
188 default:
189 throw new InternalError("unknown locale data adapter type");
190 }
191 }
192
193 public static LocaleProviderAdapter forJRE() {
194 return jreLocaleProviderAdapter;
195 }
196
197 public static LocaleProviderAdapter getResourceBundleBased() {
198 for (Type type : getAdapterPreference()) {
199 if (type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK) {
200 return forType(type);
201 }
202 }
203 // Shouldn't happen.
204 throw new InternalError();
205 }
206 /**
207 * Returns the preference order of LocaleProviderAdapter.Type
208 */
209 public static List<Type> getAdapterPreference() {
210 return adapterPreference;
211 }
212
213 /**
214 * Returns a LocaleProviderAdapter for the given locale service provider that
215 * best matches the given locale. This method returns the LocaleProviderAdapter
216 * for JRE if none is found for the given locale.
217 *
218 * @param providerClass the class for the locale service provider
219 * @param locale the desired locale.
220 * @return a LocaleProviderAdapter
221 */
222 public static LocaleProviderAdapter getAdapter(Class<? extends LocaleServiceProvider> providerClass,
223 Locale locale) {
224 LocaleProviderAdapter adapter;
225
226 // cache lookup
227 ConcurrentMap<Locale, LocaleProviderAdapter> adapterMap = adapterCache.get(providerClass);
228 if (adapterMap != null) {
229 if ((adapter = adapterMap.get(locale)) != null) {
230 return adapter;
231 }
232 } else {
233 adapterMap = new ConcurrentHashMap<>();
234 adapterCache.putIfAbsent(providerClass, adapterMap);
235 }
236
237 // Fast look-up for the given locale
238 adapter = findAdapter(providerClass, locale);
239 if (adapter != null) {
240 adapterMap.putIfAbsent(locale, adapter);
241 return adapter;
242 }
243
244 // Try finding an adapter in the normal candidate locales path of the given locale.
245 List<Locale> lookupLocales = ResourceBundle.Control.getControl(ResourceBundle.Control.FORMAT_DEFAULT)
246 .getCandidateLocales("", locale);
247 for (Locale loc : lookupLocales) {
248 if (loc.equals(locale)) {
249 // We've already done with this loc.
250 continue;
251 }
252 adapter = findAdapter(providerClass, loc);
253 if (adapter != null) {
254 adapterMap.putIfAbsent(locale, adapter);
255 return adapter;
256 }
257 }
258
259 // returns the adapter for FALLBACK as the last resort
260 adapterMap.putIfAbsent(locale, fallbackLocaleProviderAdapter);
261 return fallbackLocaleProviderAdapter;
262 }
263
264 private static LocaleProviderAdapter findAdapter(Class<? extends LocaleServiceProvider> providerClass,
265 Locale locale) {
266 for (Type type : getAdapterPreference()) {
267 LocaleProviderAdapter adapter = forType(type);
268 LocaleServiceProvider provider = adapter.getLocaleServiceProvider(providerClass);
269 if (provider != null) {
270 if (provider.isSupportedLocale(locale)) {
271 return adapter;
272 }
273 }
274 }
275 return null;
276 }
277
278 /**
279 * A utility method for implementing the default LocaleServiceProvider.isSupportedLocale
280 * for the JRE, CLDR, and FALLBACK adapters.
281 */
282 static boolean isSupportedLocale(Locale locale, LocaleProviderAdapter.Type type, Set<String> langtags) {
283 assert type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK;
284 if (Locale.ROOT.equals(locale)) {
285 return true;
286 }
287
288 if (type == Type.FALLBACK) {
289 // no other locales except ROOT are supported for FALLBACK
290 return false;
291 }
292
293 locale = locale.stripExtensions();
294 if (langtags.contains(locale.toLanguageTag())) {
295 return true;
296 }
297 if (type == Type.JRE) {
298 String oldname = locale.toString().replace('_', '-');
299 return langtags.contains(oldname) ||
300 "ja-JP-JP".equals(oldname) ||
301 "th-TH-TH".equals(oldname) ||
302 "no-NO-NY".equals(oldname);
303 }
304 return false;
305 }
306
307 public static Locale[] toLocaleArray(Set<String> tags) {
308 Locale[] locs = new Locale[tags.size() + 1];
309 int index = 0;
310 locs[index++] = Locale.ROOT;
311 for (String tag : tags) {
312 switch (tag) {
313 case "ja-JP-JP":
314 locs[index++] = JRELocaleConstants.JA_JP_JP;
315 break;
316 case "th-TH-TH":
317 locs[index++] = JRELocaleConstants.TH_TH_TH;
318 break;
319 default:
320 locs[index++] = Locale.forLanguageTag(tag);
321 break;
322 }
323 }
324 return locs;
325 }
326
327 /**
328 * Returns the type of this LocaleProviderAdapter
329 */
330 public abstract LocaleProviderAdapter.Type getAdapterType();
331
332 /**
333 * Getter method for Locale Service Providers.
334 */
335 public abstract <P extends LocaleServiceProvider> P getLocaleServiceProvider(Class<P> c);
336
337 /**
338 * Returns a BreakIteratorProvider for this LocaleProviderAdapter, or null if no
339 * BreakIteratorProvider is available.
340 *
341 * @return a BreakIteratorProvider
342 */
343 public abstract BreakIteratorProvider getBreakIteratorProvider();
344
345 /**
346 * Returns a ollatorProvider for this LocaleProviderAdapter, or null if no
347 * ollatorProvider is available.
348 *
349 * @return a ollatorProvider
350 */
351 public abstract CollatorProvider getCollatorProvider();
352
353 /**
354 * Returns a DateFormatProvider for this LocaleProviderAdapter, or null if no
355 * DateFormatProvider is available.
356 *
357 * @return a DateFormatProvider
358 */
359 public abstract DateFormatProvider getDateFormatProvider();
360
361 /**
362 * Returns a DateFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
363 * DateFormatSymbolsProvider is available.
364 *
365 * @return a DateFormatSymbolsProvider
366 */
367 public abstract DateFormatSymbolsProvider getDateFormatSymbolsProvider();
368
369 /**
370 * Returns a DecimalFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
371 * DecimalFormatSymbolsProvider is available.
372 *
373 * @return a DecimalFormatSymbolsProvider
374 */
375 public abstract DecimalFormatSymbolsProvider getDecimalFormatSymbolsProvider();
376
377 /**
378 * Returns a NumberFormatProvider for this LocaleProviderAdapter, or null if no
379 * NumberFormatProvider is available.
380 *
381 * @return a NumberFormatProvider
382 */
383 public abstract NumberFormatProvider getNumberFormatProvider();
384
385 /*
386 * Getter methods for java.util.spi.* providers
387 */
388
389 /**
390 * Returns a CurrencyNameProvider for this LocaleProviderAdapter, or null if no
391 * CurrencyNameProvider is available.
392 *
393 * @return a CurrencyNameProvider
394 */
395 public abstract CurrencyNameProvider getCurrencyNameProvider();
396
397 /**
398 * Returns a LocaleNameProvider for this LocaleProviderAdapter, or null if no
399 * LocaleNameProvider is available.
400 *
401 * @return a LocaleNameProvider
402 */
403 public abstract LocaleNameProvider getLocaleNameProvider();
404
405 /**
406 * Returns a TimeZoneNameProvider for this LocaleProviderAdapter, or null if no
407 * TimeZoneNameProvider is available.
408 *
409 * @return a TimeZoneNameProvider
410 */
411 public abstract TimeZoneNameProvider getTimeZoneNameProvider();
412
413 /**
414 * Returns a CalendarDataProvider for this LocaleProviderAdapter, or null if no
415 * CalendarDataProvider is available.
416 *
417 * @return a CalendarDataProvider
418 */
419 public abstract CalendarDataProvider getCalendarDataProvider();
420
421 /**
422 * Returns a CalendarNameProvider for this LocaleProviderAdapter, or null if no
423 * CalendarNameProvider is available.
424 *
425 * @return a CalendarNameProvider
426 */
427 public abstract CalendarNameProvider getCalendarNameProvider();
428
429 /**
430 * Returns a CalendarProvider for this LocaleProviderAdapter, or null if no
431 * CalendarProvider is available.
432 *
433 * @return a CalendarProvider
434 */
435 public abstract CalendarProvider getCalendarProvider();
436
437 public abstract LocaleResources getLocaleResources(Locale locale);
438
439 public abstract Locale[] getAvailableLocales();
440 }