1 /*
2 * Copyright (c) 2012, 2014, 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.util.Locale;
29 import java.util.Set;
30 import java.util.TimeZone;
31 import java.util.spi.TimeZoneNameProvider;
32
33 /**
34 * Concrete implementation of the
35 * {@link java.util.spi.TimeZoneNameProvider TimeZoneNameProvider} class
36 * for the JRE LocaleProviderAdapter.
37 *
38 * @author Naoto Sato
39 * @author Masayoshi Okutsu
40 */
41 public class TimeZoneNameProviderImpl extends TimeZoneNameProvider {
42 private final LocaleProviderAdapter.Type type;
43 private Set<String> langtags;
44
45 TimeZoneNameProviderImpl(LocaleProviderAdapter.Type type) {
46 this.type = type;
47 }
48
49 /**
50 * Returns an array of all locales for which this locale service provider
51 * can provide localized objects or names.
52 *
53 * @return An array of all locales for which this locale service provider
54 * can provide localized objects or names.
55 */
56 @Override
57 public Locale[] getAvailableLocales() {
58 return LocaleProviderAdapter.toLocaleArray(getLangTags());
59 }
60
61 @Override
62 public boolean isSupportedLocale(Locale locale) {
63 return LocaleProviderAdapter.isSupportedLocale(locale, type, getLangTags());
64 }
65
66 /**
67 * Returns a name for the given time zone ID that's suitable for
68 * presentation to the user in the specified locale. The given time
69 * zone ID is "GMT" or one of the names defined using "Zone" entries
70 * in the "tz database", a public domain time zone database at
71 * <a href="ftp://elsie.nci.nih.gov/pub/">ftp://elsie.nci.nih.gov/pub/</a>.
72 * The data of this database is contained in a file whose name starts with
73 * "tzdata", and the specification of the data format is part of the zic.8
74 * man page, which is contained in a file whose name starts with "tzcode".
75 * <p>
76 * If <code>daylight</code> is true, the method should return a name
77 * appropriate for daylight saving time even if the specified time zone
78 * has not observed daylight saving time in the past.
79 *
80 * @param id a time zone ID string
81 * @param daylight if true, return the daylight saving name.
82 * @param style either {@link java.util.TimeZone#LONG TimeZone.LONG} or
83 * {@link java.util.TimeZone#SHORT TimeZone.SHORT}
84 * @param locale the desired locale
85 * @return the human-readable name of the given time zone in the
86 * given locale, or null if it's not available.
87 * @exception IllegalArgumentException if <code>style</code> is invalid,
88 * or <code>locale</code> isn't one of the locales returned from
89 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
90 * getAvailableLocales()}.
91 * @exception NullPointerException if <code>ID</code> or <code>locale</code>
92 * is null
93 * @see java.util.TimeZone#getDisplayName(boolean, int, java.util.Locale)
94 */
95 @Override
96 public String getDisplayName(String id, boolean daylight, int style, Locale locale) {
97 String[] names = getDisplayNameArray(id, 5, locale);
98 if (names != null) {
99 int index = daylight ? 3 : 1;
100 if (style == TimeZone.SHORT) {
101 index++;
102 }
103 return names[index];
104 }
105 return null;
106 }
107
108 @Override
109 public String getGenericDisplayName(String id, int style, Locale locale) {
110 String[] names = getDisplayNameArray(id, 7, locale);
111 if (names != null && names.length >= 7) {
112 return names[(style == TimeZone.LONG) ? 5 : 6];
113 }
114 return null;
115 }
116
117 private String[] getDisplayNameArray(String id, int n, Locale locale) {
118 if (id == null || locale == null) {
119 throw new NullPointerException();
120 }
121 return LocaleProviderAdapter.forType(type).getLocaleResources(locale).getTimeZoneNames(id, n);
122 }
123
124 private Set<String> getLangTags() {
125 if (langtags == null) {
126 langtags = ((JRELocaleProviderAdapter)LocaleProviderAdapter.forType(type)).getLanguageTagSet("TimeZoneNames");
127 }
128 return langtags;
129 }
130
131 /**
132 * Returns a String[][] as the DateFormatSymbols.getZoneStrings() value for
133 * the given locale. This method is package private.
134 *
135 * @param locale a Locale for time zone names
136 * @return an array of time zone names arrays
137 */
138 String[][] getZoneStrings(Locale locale) {
139 return LocaleProviderAdapter.forType(type).getLocaleResources(locale).getZoneStrings();
140 }
141 }