1 /*
   2  * Copyright (c) 2012, 2013, 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 /*
  27  * This file is available under and governed by the GNU General Public
  28  * License version 2 only, as published by the Free Software Foundation.
  29  * However, the following notice accompanied the original version of this
  30  * file:
  31  *
  32  * Copyright (c) 2009-2012, Stephen Colebourne & Michael Nascimento Santos
  33  *
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions are met:
  38  *
  39  *  * Redistributions of source code must retain the above copyright notice,
  40  *    this list of conditions and the following disclaimer.
  41  *
  42  *  * Redistributions in binary form must reproduce the above copyright notice,
  43  *    this list of conditions and the following disclaimer in the documentation
  44  *    and/or other materials provided with the distribution.
  45  *
  46  *  * Neither the name of JSR-310 nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  54  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  55  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  56  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  57  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  58  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  59  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  */
  62 package java.time.format;
  63 
  64 import java.text.SimpleDateFormat;
  65 import java.time.chrono.Chronology;
  66 import java.util.Locale;
  67 import java.util.concurrent.ConcurrentHashMap;
  68 import java.util.concurrent.ConcurrentMap;
  69 import sun.util.locale.provider.LocaleProviderAdapter;
  70 import sun.util.locale.provider.LocaleResources;
  71 
  72 /**
  73  * A provider to obtain date-time formatters for a style.
  74  * <p>
  75  *
  76  * <h3>Specification for implementors</h3>
  77  * This implementation is based on extraction of data from a {@link SimpleDateFormat}.
  78  * This class is immutable and thread-safe.
  79  * This Implementations caches the returned formatters.
  80  *
  81  * @since 1.8
  82  */
  83 final class DateTimeFormatStyleProvider {
  84     // TODO: Better implementation based on CLDR
  85 
  86     /** Cache of formatters. */
  87     private static final ConcurrentMap<String, Object> FORMATTER_CACHE = new ConcurrentHashMap<>(16, 0.75f, 2);
  88 
  89     private DateTimeFormatStyleProvider() {}
  90 
  91     /**
  92      * Gets an Instance of the provider of format styles.
  93      *
  94      * @return the provider, not null
  95      */
  96     static DateTimeFormatStyleProvider getInstance() {
  97         return new DateTimeFormatStyleProvider();
  98     }
  99 
 100     /**
 101      * Gets a localized date, time or date-time formatter.
 102      * <p>
 103      * The formatter will be the most appropriate to use for the date and time style in the locale.
 104      * For example, some locales will use the month name while others will use the number.
 105      *
 106      * @param dateStyle  the date formatter style to obtain, null to obtain a time formatter
 107      * @param timeStyle  the time formatter style to obtain, null to obtain a date formatter
 108      * @param chrono  the chronology to use, not null
 109      * @param locale  the locale to use, not null
 110      * @return the date-time formatter, not null
 111      * @throws IllegalArgumentException if both format styles are null or if the locale is not recognized
 112      */
 113     public DateTimeFormatter getFormatter(
 114             FormatStyle dateStyle, FormatStyle timeStyle, Chronology chrono, Locale locale) {
 115         if (dateStyle == null && timeStyle == null) {
 116             throw new IllegalArgumentException("Date and Time style must not both be null");
 117         }
 118         String key = chrono.getId() + '|' + locale.toString() + '|' + dateStyle + timeStyle;
 119         Object cached = FORMATTER_CACHE.get(key);
 120         if (cached != null) {
 121             return (DateTimeFormatter) cached;
 122         }
 123 
 124         LocaleResources lr = LocaleProviderAdapter.getResourceBundleBased()
 125                                     .getLocaleResources(locale);
 126         String pattern = lr.getCldrDateTimePattern(convertStyle(timeStyle), convertStyle(dateStyle),
 127                                                    chrono.getCalendarType());
 128         DateTimeFormatter formatter = new DateTimeFormatterBuilder().appendPattern(pattern).toFormatter(locale);
 129         FORMATTER_CACHE.putIfAbsent(key, formatter);
 130         return formatter;
 131     }
 132 
 133     /**
 134      * Converts the enum style to the java.util.Calendar style. Standalone styles
 135      * are not supported.
 136      *
 137      * @param style  the enum style
 138      * @return the int style, or -1 if style is null, indicating unrequired
 139      */
 140     private int convertStyle(FormatStyle style) {
 141         if (style == null) {
 142             return -1;
 143         }
 144         return style.ordinal();  // indices happen to align
 145     }
 146 
 147 }