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