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 package sun.util.locale.provider;
  26 
  27 import static java.util.Calendar.*;
  28 import java.util.Comparator;
  29 import java.util.Locale;
  30 import java.util.Map;
  31 import java.util.ResourceBundle;
  32 import java.util.Set;
  33 import java.util.TreeMap;
  34 import java.util.spi.CalendarNameProvider;
  35 
  36 /**
  37  * Concrete implementation of the  {@link java.util.spi.CalendarDataProvider
  38  * CalendarDataProvider} class for the JRE LocaleProviderAdapter.
  39  *
  40  * @author Masayoshi Okutsu
  41  * @author Naoto Sato
  42  */
  43 public class CalendarNameProviderImpl extends CalendarNameProvider implements AvailableLanguageTags {
  44     private final LocaleProviderAdapter.Type type;
  45     private final Set<String> langtags;
  46 
  47     public CalendarNameProviderImpl(LocaleProviderAdapter.Type type, Set<String> langtags) {
  48         this.type = type;
  49         this.langtags = langtags;
  50     }
  51 
  52     @Override
  53     public String getDisplayName(String calendarType, int field, int value, int style, Locale locale) {
  54         String name = null;
  55         String key = getKey(calendarType, field, style);
  56         if (key != null) {
  57             ResourceBundle rb = LocaleProviderAdapter.forType(type).getLocaleData().getDateFormatData(locale);
  58             if (rb.containsKey(key)) {
  59                 String[] strings = rb.getStringArray(key);
  60                 if (strings.length > 0) {
  61                     if (field == DAY_OF_WEEK || field == YEAR) {
  62                         --value;
  63                     }
  64                     name = strings[value];
  65                     // If name is empty in standalone, try its `format' style.
  66                     if (name.length() == 0
  67                             && (style == SHORT_STANDALONE || style == LONG_STANDALONE)) {
  68                         name = getDisplayName(calendarType, field, value,
  69                                               style == SHORT_STANDALONE ? SHORT_FORMAT : LONG_FORMAT,
  70                                               locale);
  71                     }
  72                 }
  73             }
  74         }
  75         return name;
  76     }
  77 
  78     @Override
  79     public Map<String, Integer> getDisplayNames(String calendarType, int field, int style, Locale locale) {
  80         Map<String, Integer> names;
  81         if (style == ALL_STYLES) {
  82             names = getDisplayNamesImpl(calendarType, field, SHORT_FORMAT, locale);
  83             if (field != AM_PM) {
  84                 for (int st : new int[] { SHORT_STANDALONE, LONG_FORMAT, LONG_STANDALONE }) {
  85                     names.putAll(getDisplayNamesImpl(calendarType, field, st, locale));
  86                 }
  87             }
  88         } else {
  89             // specific style
  90             names = getDisplayNamesImpl(calendarType, field, style, locale);
  91         }
  92         return names.isEmpty() ? null : names;
  93     }
  94 
  95     private Map<String, Integer> getDisplayNamesImpl(String calendarType, int field,
  96                                                      int style, Locale locale) {
  97         String key = getKey(calendarType, field, style);
  98         Map<String, Integer> map = new TreeMap<>(LengthBasedComparator.INSTANCE);
  99         if (key != null) {
 100             ResourceBundle rb = LocaleProviderAdapter.forType(type).getLocaleData().getDateFormatData(locale);
 101             if (rb.containsKey(key)) {
 102                 String[] strings = rb.getStringArray(key);
 103                 if (field == YEAR) {
 104                     if (strings.length > 0) {
 105                         map.put(strings[0], 1);
 106                     }
 107                 } else {
 108                     int base = (field == DAY_OF_WEEK) ? 1 : 0;
 109                     for (int i = 0; i < strings.length; i++) {
 110                         String name = strings[i];
 111                         // Ignore any empty string (some standalone month names
 112                         // are not defined)
 113                         if (name.length() == 0) {
 114                             continue;
 115                         }
 116                         map.put(name, base + i);
 117                     }
 118                 }
 119             }
 120         }
 121         return map;
 122     }
 123 
 124     /**
 125      * Comparator implementation for TreeMap which iterates keys from longest
 126      * to shortest.
 127      */
 128     private static class LengthBasedComparator implements Comparator<String> {
 129         private static final LengthBasedComparator INSTANCE = new LengthBasedComparator();
 130 
 131         private LengthBasedComparator() {
 132         }
 133 
 134         @Override
 135         public int compare(String o1, String o2) {
 136             int n = o2.length() - o1.length();
 137             return (n == 0) ? o1.compareTo(o2) : n;
 138         }
 139     }
 140 
 141     @Override
 142     public Locale[] getAvailableLocales() {
 143         return LocaleProviderAdapter.toLocaleArray(langtags);
 144     }
 145 
 146     @Override
 147     public boolean isSupportedLocale(Locale locale) {
 148         if (Locale.ROOT.equals(locale)) {
 149             return true;
 150         }
 151         String calendarType = null;
 152         if (locale.hasExtensions()) {
 153             calendarType = locale.getUnicodeLocaleType("ca");
 154             locale = locale.stripExtensions();
 155         }
 156 
 157         if (calendarType != null) {
 158             switch (calendarType) {
 159             case "buddhist":
 160             case "japanese":
 161             case "gregory":
 162                 break;
 163             default:
 164                 // Unknown calendar type
 165                 return false;
 166             }
 167         }
 168         if (langtags.contains(locale.toLanguageTag())) {
 169             return true;
 170         }
 171         if (type == LocaleProviderAdapter.Type.JRE) {
 172             String oldname = locale.toString().replace('_', '-');
 173             return langtags.contains(oldname);
 174         }
 175         return false;
 176     }
 177 
 178     @Override
 179     public Set<String> getAvailableLanguageTags() {
 180         return langtags;
 181     }
 182 
 183     private int getIntData(String key, Locale locale) {
 184         ResourceBundle rb = LocaleProviderAdapter.forType(type).getLocaleData().getCalendarData(locale);
 185         if (rb.containsKey(key)) {
 186             String firstday = rb.getString(key);
 187             return Integer.parseInt(firstday);
 188         }
 189         // Note that the base bundle of CLDR doesn't have the Calendar week parameters.
 190         return 0;
 191     }
 192 
 193     private String getKey(String type, int field, int style) {
 194         boolean standalone = (style & 0x8000) != 0;
 195         style &= ~0x8000;
 196 
 197         if ("gregory".equals(type)) {
 198             type = null;
 199         }
 200 
 201         StringBuilder key = new StringBuilder();
 202         switch (field) {
 203         case ERA:
 204             if (type != null) {
 205                 key.append(type).append('.');
 206             }
 207             if (style == SHORT) {
 208                 key.append("short.");
 209             }
 210             key.append("Eras");
 211             break;
 212 
 213         case YEAR:
 214             key.append(type).append(".FirstYear");
 215             break;
 216 
 217         case MONTH:
 218             if (standalone) {
 219                 key.append("standalone.");
 220             }
 221             key.append(style == SHORT ? "MonthAbbreviations" : "MonthNames");
 222             break;
 223 
 224         case DAY_OF_WEEK:
 225             key.append(style == SHORT ? "DayAbbreviations" : "DayNames");
 226             break;
 227 
 228         case AM_PM:
 229             key.append("AmPmMarkers");
 230             break;
 231         }
 232         return key.length() > 0 ? key.toString() : null;
 233     }
 234 }