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.List;
37 import java.util.Locale;
38 import java.util.ResourceBundle;
39 import java.util.Set;
40 import java.util.spi.CalendarDataProvider;
41 import java.util.spi.CalendarNameProvider;
42 import java.util.spi.CurrencyNameProvider;
43 import java.util.spi.LocaleNameProvider;
44 import java.util.spi.LocaleServiceProvider;
45 import java.util.spi.TimeZoneNameProvider;
46 import sun.util.cldr.CLDRLocaleProviderAdapter;
47 import sun.util.resources.LocaleData;
48
49 /**
50 * The LocaleProviderAdapter abstract class.
51 *
52 * @author Naoto Sato
53 * @author Masayoshi Okutsu
54 */
55 public abstract class LocaleProviderAdapter {
56 /**
57 * Adapter type.
58 */
59 public static enum Type {
60 JRE("sun.util.resources", "sun.text.resources"),
61 CLDR("sun.util.resources.cldr", "sun.text.resources.cldr"),
62 SPI,
63 HOST,
64 FALLBACK("sun.util.resources", "sun.text.resources");
65
66 private final String UTIL_RESOURCES_PACKAGE;
67 private final String TEXT_RESOURCES_PACKAGE;
68
69 private Type() {
70 this(null, null);
71 }
72
73 private Type(String util, String text) {
74 UTIL_RESOURCES_PACKAGE = util;
75 TEXT_RESOURCES_PACKAGE = text;
76 }
77
78 public String getUtilResourcesPackage() {
79 return UTIL_RESOURCES_PACKAGE;
80 }
81
82 public String getTextResourcesPackage() {
83 return TEXT_RESOURCES_PACKAGE;
84 }
85 }
86
87 /**
88 * LocaleProviderAdapter preference list. The default list is intended
89 * to behave the same manner in JDK7.
90 */
91 private static Type[] adapterPreference = {
92 Type.JRE,
93 Type.SPI,
94 };
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 static {
123 String order = AccessController.doPrivileged(
124 new sun.security.action.GetPropertyAction("java.locale.providers"));
125 // Override adapterPreference with the properties one
126 if (order != null && order.length() != 0) {
127 String[] types = order.split(",");
128 List<Type> typeList = new ArrayList<>();
129 for (String type : types) {
130 try {
131 Type aType = Type.valueOf(type.trim().toUpperCase(Locale.ROOT));
132
133 // load adapter if necessary
134 switch (aType) {
135 case CLDR:
136 cldrLocaleProviderAdapter = new CLDRLocaleProviderAdapter();
137 break;
138 case HOST:
139 hostLocaleProviderAdapter = new HostLocaleProviderAdapter();
140 break;
141 }
142 typeList.add(aType);
143 } catch (IllegalArgumentException | UnsupportedOperationException e) {
144 // could be caused by the user specifying wrong
145 // provider name or format in the system property
146 LocaleServiceProviderPool.config(LocaleProviderAdapter.class, e.toString());
147 }
148 }
149
150 if (!typeList.isEmpty()) {
151 if (!typeList.contains(Type.JRE)) {
152 // Append FALLBACK as the last resort.
153 fallbackLocaleProviderAdapter = new FallbackLocaleProviderAdapter();
154 typeList.add(Type.FALLBACK);
155 }
156 adapterPreference = typeList.toArray(new Type[0]);
157 }
158 }
159 }
160
161
162 /**
163 * Returns the singleton instance for each adapter type
164 */
165 public static LocaleProviderAdapter forType(Type type) {
166 switch (type) {
167 case JRE:
168 return jreLocaleProviderAdapter;
169 case CLDR:
170 return cldrLocaleProviderAdapter;
171 case SPI:
172 return spiLocaleProviderAdapter;
173 case HOST:
174 return hostLocaleProviderAdapter;
175 case FALLBACK:
176 return fallbackLocaleProviderAdapter;
177 default:
178 throw new InternalError("unknown locale data adapter type");
179 }
180 }
181
182 public static LocaleProviderAdapter forJRE() {
183 return jreLocaleProviderAdapter;
184 }
185
186 public static LocaleProviderAdapter getResourceBundleBased() {
187 for (Type type : getAdapterPreference()) {
188 if (type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK) {
189 return forType(type);
190 }
191 }
192 // Shouldn't happen.
193 throw new InternalError();
194 }
195 /**
196 * Returns the preference order of LocaleProviderAdapter.Type
197 */
198 public static Type[] getAdapterPreference() {
199 return adapterPreference;
200 }
201
202 /**
203 * Returns a LocaleProviderAdapter for the given locale service provider that
204 * best matches the given locale. This method returns the LocaleProviderAdapter
205 * for JRE if none is found for the given locale.
206 *
207 * @param providerClass the class for the locale service provider
208 * @param locale the desired locale.
209 * @return a LocaleProviderAdapter
210 */
211 public static LocaleProviderAdapter getAdapter(Class<? extends LocaleServiceProvider> providerClass,
212 Locale locale) {
213 // Fast look-up for the given locale
214 LocaleProviderAdapter adapter = findAdapter(providerClass, locale);
215 if (adapter != null) {
216 return adapter;
217 }
218
219 // Try finding an adapter in the normal candidate locales path of the given locale.
220 List<Locale> lookupLocales = ResourceBundle.Control.getControl(ResourceBundle.Control.FORMAT_DEFAULT)
221 .getCandidateLocales("", locale);
222 for (Locale loc : lookupLocales) {
223 if (loc.equals(locale)) {
224 // We've already done with this loc.
225 continue;
226 }
227 adapter = findAdapter(providerClass, loc);
228 if (adapter != null) {
229 return adapter;
230 }
231 }
232
233 // returns the adapter for FALLBACK as the last resort
234 return fallbackLocaleProviderAdapter;
235 }
236
237 private static LocaleProviderAdapter findAdapter(Class<? extends LocaleServiceProvider> providerClass,
238 Locale locale) {
239 for (Type type : getAdapterPreference()) {
240 LocaleProviderAdapter adapter = forType(type);
241 LocaleServiceProvider provider = adapter.getLocaleServiceProvider(providerClass);
242 if (provider != null) {
243 if (provider.isSupportedLocale(locale)) {
244 return adapter;
245 }
246 }
247 }
248 return null;
249 }
250
251 /**
252 * A utility method for implementing the default LocaleServiceProvider.isSupportedLocale
253 * for the JRE, CLDR, and FALLBACK adapters.
254 */
255 static boolean isSupportedLocale(Locale locale, LocaleProviderAdapter.Type type, Set<String> langtags) {
256 assert type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK;
257 if (Locale.ROOT.equals(locale)) {
258 return true;
259 }
260
261 if (type == Type.FALLBACK) {
262 // no other locales except ROOT are supported for FALLBACK
263 return false;
264 }
265
266 locale = locale.stripExtensions();
267 if (langtags.contains(locale.toLanguageTag())) {
268 return true;
269 }
270 if (type == Type.JRE) {
271 String oldname = locale.toString().replace('_', '-');
272 return langtags.contains(oldname);
273 }
274 return false;
275 }
276
277 public static Locale[] toLocaleArray(Set<String> tags) {
278 Locale[] locs = new Locale[tags.size() + 1];
279 int index = 0;
280 locs[index++] = Locale.ROOT;
281 for (String tag : tags) {
282 switch (tag) {
283 case "ja-JP-JP":
284 locs[index++] = JRELocaleConstants.JA_JP_JP;
285 break;
286 case "th-TH-TH":
287 locs[index++] = JRELocaleConstants.TH_TH_TH;
288 break;
289 default:
290 locs[index++] = Locale.forLanguageTag(tag);
291 break;
292 }
293 }
294 return locs;
295 }
296
297 /**
298 * Returns the type of this LocaleProviderAdapter
299 */
300 public abstract LocaleProviderAdapter.Type getAdapterType();
301
302 /**
303 * Getter method for Locale Service Providers.
304 */
305 public abstract <P extends LocaleServiceProvider> P getLocaleServiceProvider(Class<P> c);
306
307 /**
308 * Returns a BreakIteratorProvider for this LocaleProviderAdapter, or null if no
309 * BreakIteratorProvider is available.
310 *
311 * @return a BreakIteratorProvider
312 */
313 public abstract BreakIteratorProvider getBreakIteratorProvider();
314
315 /**
316 * Returns a ollatorProvider for this LocaleProviderAdapter, or null if no
317 * ollatorProvider is available.
318 *
319 * @return a ollatorProvider
320 */
321 public abstract CollatorProvider getCollatorProvider();
322
323 /**
324 * Returns a DateFormatProvider for this LocaleProviderAdapter, or null if no
325 * DateFormatProvider is available.
326 *
327 * @return a DateFormatProvider
328 */
329 public abstract DateFormatProvider getDateFormatProvider();
330
331 /**
332 * Returns a DateFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
333 * DateFormatSymbolsProvider is available.
334 *
335 * @return a DateFormatSymbolsProvider
336 */
337 public abstract DateFormatSymbolsProvider getDateFormatSymbolsProvider();
338
339 /**
340 * Returns a DecimalFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
341 * DecimalFormatSymbolsProvider is available.
342 *
343 * @return a DecimalFormatSymbolsProvider
344 */
345 public abstract DecimalFormatSymbolsProvider getDecimalFormatSymbolsProvider();
346
347 /**
348 * Returns a NumberFormatProvider for this LocaleProviderAdapter, or null if no
349 * NumberFormatProvider is available.
350 *
351 * @return a NumberFormatProvider
352 */
353 public abstract NumberFormatProvider getNumberFormatProvider();
354
355 /*
356 * Getter methods for java.util.spi.* providers
357 */
358
359 /**
360 * Returns a CurrencyNameProvider for this LocaleProviderAdapter, or null if no
361 * CurrencyNameProvider is available.
362 *
363 * @return a CurrencyNameProvider
364 */
365 public abstract CurrencyNameProvider getCurrencyNameProvider();
366
367 /**
368 * Returns a LocaleNameProvider for this LocaleProviderAdapter, or null if no
369 * LocaleNameProvider is available.
370 *
371 * @return a LocaleNameProvider
372 */
373 public abstract LocaleNameProvider getLocaleNameProvider();
374
375 /**
376 * Returns a TimeZoneNameProvider for this LocaleProviderAdapter, or null if no
377 * TimeZoneNameProvider is available.
378 *
379 * @return a TimeZoneNameProvider
380 */
381 public abstract TimeZoneNameProvider getTimeZoneNameProvider();
382
383 /**
384 * Returns a CalendarDataProvider for this LocaleProviderAdapter, or null if no
385 * CalendarDataProvider is available.
386 *
387 * @return a CalendarDataProvider
388 */
389 public abstract CalendarDataProvider getCalendarDataProvider();
390
391 /**
392 * Returns a CalendarNameProvider for this LocaleProviderAdapter, or null if no
393 * CalendarNameProvider is available.
394 *
395 * @return a CalendarNameProvider
396 */
397 public abstract CalendarNameProvider getCalendarNameProvider();
398
399 public abstract LocaleResources getLocaleResources(Locale locale);
400
401 public abstract LocaleData getLocaleData();
402
403 public abstract Locale[] getAvailableLocales();
404 }