1 /*
   2  * Copyright (c) 2012, 2015, 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.security.PrivilegedAction;
  30 import java.text.spi.BreakIteratorProvider;
  31 import java.text.spi.CollatorProvider;
  32 import java.text.spi.DateFormatProvider;
  33 import java.text.spi.DateFormatSymbolsProvider;
  34 import java.text.spi.DecimalFormatSymbolsProvider;
  35 import java.text.spi.NumberFormatProvider;
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.List;
  39 import java.util.Locale;
  40 import java.util.concurrent.ConcurrentHashMap;
  41 import java.util.concurrent.ConcurrentMap;
  42 import java.util.spi.CalendarDataProvider;
  43 import java.util.spi.CalendarNameProvider;
  44 import java.util.spi.CurrencyNameProvider;
  45 import java.util.spi.LocaleNameProvider;
  46 import java.util.spi.LocaleServiceProvider;
  47 import java.util.spi.TimeZoneNameProvider;
  48 import sun.util.spi.CalendarProvider;
  49 
  50 /**
  51  * An abstract parent class for the
  52  * HostLocaleProviderAdapter/SPILocaleProviderAdapter.
  53  *
  54  * @author Naoto Sato
  55  * @author Masayoshi Okutsu
  56  */
  57 public abstract class AuxLocaleProviderAdapter extends LocaleProviderAdapter {
  58     /**
  59      * SPI implementations map
  60      */
  61     private final ConcurrentMap<Class<? extends LocaleServiceProvider>, LocaleServiceProvider> providersMap =
  62             new ConcurrentHashMap<>();
  63 
  64     /**
  65      * Getter method for Locale Service Providers
  66      */
  67     @Override
  68     public <P extends LocaleServiceProvider> P getLocaleServiceProvider(Class<P> c) {
  69         @SuppressWarnings("unchecked")
  70         P lsp = (P) providersMap.get(c);
  71         if (lsp == null) {
  72             lsp = findInstalledProvider(c);
  73             providersMap.putIfAbsent(c, lsp == null ? NULL_PROVIDER : lsp);
  74         }
  75 
  76         return lsp;
  77     }
  78 
  79     /**
  80      * Real body to find an implementation for each SPI.
  81      *
  82      * @param <P>
  83      * @param c
  84      * @return
  85      */
  86     protected abstract <P extends LocaleServiceProvider> P findInstalledProvider(final Class<P> c);
  87 
  88     @Override
  89     public BreakIteratorProvider getBreakIteratorProvider() {
  90         return getLocaleServiceProvider(BreakIteratorProvider.class);
  91     }
  92 
  93     @Override
  94     public CollatorProvider getCollatorProvider() {
  95         return getLocaleServiceProvider(CollatorProvider.class);
  96     }
  97 
  98     @Override
  99     public DateFormatProvider getDateFormatProvider() {
 100         return getLocaleServiceProvider(DateFormatProvider.class);
 101     }
 102 
 103     @Override
 104     public DateFormatSymbolsProvider getDateFormatSymbolsProvider() {
 105         return getLocaleServiceProvider(DateFormatSymbolsProvider.class);
 106     }
 107 
 108     @Override
 109     public DecimalFormatSymbolsProvider getDecimalFormatSymbolsProvider() {
 110         return getLocaleServiceProvider(DecimalFormatSymbolsProvider.class);
 111     }
 112 
 113     @Override
 114     public NumberFormatProvider getNumberFormatProvider() {
 115         return getLocaleServiceProvider(NumberFormatProvider.class);
 116     }
 117 
 118     /**
 119      * Getter methods for java.util.spi.* providers
 120      */
 121     @Override
 122     public CurrencyNameProvider getCurrencyNameProvider() {
 123         return getLocaleServiceProvider(CurrencyNameProvider.class);
 124     }
 125 
 126     @Override
 127     public LocaleNameProvider getLocaleNameProvider() {
 128         return getLocaleServiceProvider(LocaleNameProvider.class);
 129     }
 130 
 131     @Override
 132     public TimeZoneNameProvider getTimeZoneNameProvider() {
 133         return getLocaleServiceProvider(TimeZoneNameProvider.class);
 134     }
 135 
 136     @Override
 137     public CalendarDataProvider getCalendarDataProvider() {
 138         return getLocaleServiceProvider(CalendarDataProvider.class);
 139     }
 140 
 141     @Override
 142     public CalendarNameProvider getCalendarNameProvider() {
 143         return getLocaleServiceProvider(CalendarNameProvider.class);
 144     }
 145 
 146     /**
 147      * Getter methods for sun.util.spi.* providers
 148      */
 149     @Override
 150     public CalendarProvider getCalendarProvider() {
 151         return getLocaleServiceProvider(CalendarProvider.class);
 152     }
 153 
 154     @Override
 155     public LocaleResources getLocaleResources(Locale locale) {
 156         return null;
 157     }
 158 
 159     private static Locale[] availableLocales = null;
 160 
 161     @Override
 162     public Locale[] getAvailableLocales() {
 163         if (availableLocales == null) {
 164             List<Locale> avail = new ArrayList<>();
 165             for (Class<? extends LocaleServiceProvider> c :
 166                     LocaleServiceProviderPool.spiClasses) {
 167                 LocaleServiceProvider lsp = getLocaleServiceProvider(c);
 168                 if (lsp != null) {
 169                     avail.addAll(Arrays.asList(lsp.getAvailableLocales()));
 170                 }
 171             }
 172             availableLocales = avail.toArray(new Locale[0]);
 173         }
 174 
 175         // assuming caller won't mutate the array.
 176         return availableLocales;
 177     }
 178 
 179     /**
 180      * A dummy locale service provider that indicates there is no
 181      * provider available
 182      */
 183     private static final NullProvider NULL_PROVIDER = AccessController.doPrivileged(
 184         (PrivilegedAction<NullProvider>) () -> new NullProvider());
 185 
 186     private static class NullProvider extends LocaleServiceProvider {
 187         @Override
 188         public Locale[] getAvailableLocales() {
 189             return new Locale[0];
 190         }
 191     }
 192 }