/*

 * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * (C) Copyright Taligent, Inc. 1996 - All Rights Reserved

 * (C) Copyright IBM Corp. 1996 - All Rights Reserved

 *

 *   The original version of this source code and documentation is copyrighted

 * and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These

 * materials are provided under terms of a License Agreement between Taligent

 * and Sun. This technology is protected by multiple US and International

 * patents. This notice and attribution to Taligent may not be removed.

 *   Taligent is a registered trademark of Taligent, Inc.

 *

 */

package java.text;

import java.io.IOException;

import java.io.ObjectOutputStream;

import java.io.Serializable;

import java.lang.ref.SoftReference;

import java.text.spi.DateFormatSymbolsProvider;

import java.util.Arrays;

import java.util.List;

import java.util.Locale;

import java.util.ResourceBundle;

import java.util.TimeZone;

import java.util.concurrent.ConcurrentHashMap;

import java.util.concurrent.ConcurrentMap;

import java.util.spi.LocaleServiceProvider;

import sun.util.LocaleServiceProviderPool;

import sun.util.TimeZoneNameUtility;

import sun.util.calendar.ZoneInfo;

import sun.util.resources.LocaleData;

/**

 * <code>DateFormatSymbols</code> is a public class for encapsulating

 * localizable date-time formatting data, such as the names of the

 * months, the names of the days of the week, and the time zone data.

 * <code>DateFormat</code> and <code>SimpleDateFormat</code> both use

 * <code>DateFormatSymbols</code> to encapsulate this information.

 *

 * <p>

 * Typically you shouldn't use <code>DateFormatSymbols</code> directly.

 * Rather, you are encouraged to create a date-time formatter with the

 * <code>DateFormat</code> class's factory methods: <code>getTimeInstance</code>,

 * <code>getDateInstance</code>, or <code>getDateTimeInstance</code>.

 * These methods automatically create a <code>DateFormatSymbols</code> for

 * the formatter so that you don't have to. After the

 * formatter is created, you may modify its format pattern using the

 * <code>setPattern</code> method. For more information about

 * creating formatters using <code>DateFormat</code>'s factory methods,

 * see {@link DateFormat}.

 *

 * <p>

 * If you decide to create a date-time formatter with a specific

 * format pattern for a specific locale, you can do so with:

 * <blockquote>

 * <pre>

 * new SimpleDateFormat(aPattern, DateFormatSymbols.getInstance(aLocale)).

 * </pre>

 * </blockquote>

 *

 * <p>

 * <code>DateFormatSymbols</code> objects are cloneable. When you obtain

 * a <code>DateFormatSymbols</code> object, feel free to modify the

 * date-time formatting data. For instance, you can replace the localized

 * date-time format pattern characters with the ones that you feel easy

 * to remember. Or you can change the representative cities

 * to your favorite ones.

 *

 * <p>

 * New <code>DateFormatSymbols</code> subclasses may be added to support

 * <code>SimpleDateFormat</code> for date-time formatting for additional locales.

 * @see          DateFormat

 * @see          SimpleDateFormat

 * @see          java.util.SimpleTimeZone

 * @author       Chen-Lieh Huang

 */

public class DateFormatSymbols implements Serializable, Cloneable {

    /**

     * Construct a DateFormatSymbols object by loading format data from

     * resources for the default locale. This constructor can only

     * construct instances for the locales supported by the Java

     * runtime environment, not for those supported by installed

     * {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}

     * implementations. For full locale coverage, use the

     * {@link #getInstance(Locale) getInstance} method.

     *

     * @see #getInstance()

     * @exception  java.util.MissingResourceException

     *             if the resources for the default locale cannot be

     *             found or cannot be loaded.

     */

    public DateFormatSymbols()

    {

        initializeData(Locale.getDefault(Locale.Category.FORMAT));

    }

    /**

     * Construct a DateFormatSymbols object by loading format data from

     * resources for the given locale. This constructor can only

     * construct instances for the locales supported by the Java

     * runtime environment, not for those supported by installed

     * {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}

     * implementations. For full locale coverage, use the

     * {@link #getInstance(Locale) getInstance} method.

     *

     * @see #getInstance(Locale)

     * @exception  java.util.MissingResourceException

     *             if the resources for the specified locale cannot be

     *             found or cannot be loaded.

     */

    public DateFormatSymbols(Locale locale)

    {

        initializeData(locale);

    }

    /**

     * Era strings. For example: "AD" and "BC".  An array of 2 strings,

     * indexed by <code>Calendar.BC</code> and <code>Calendar.AD</code>.

     * @serial

     */

    String eras[] = null;

    /**

     * Month strings. For example: "January", "February", etc.  An array

     * of 13 strings (some calendars have 13 months), indexed by

     * <code>Calendar.JANUARY</code>, <code>Calendar.FEBRUARY</code>, etc.

     * @serial

     */

    String months[] = null;

    /**

     * Short month strings. For example: "Jan", "Feb", etc.  An array of

     * 13 strings (some calendars have 13 months), indexed by

     * <code>Calendar.JANUARY</code>, <code>Calendar.FEBRUARY</code>, etc.

     * @serial

     */

    String shortMonths[] = null;

    /**

     * Weekday strings. For example: "Sunday", "Monday", etc.  An array

     * of 8 strings, indexed by <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc.

     * The element <code>weekdays[0]</code> is ignored.

     * @serial

     */

    String weekdays[] = null;

    /**

     * Short weekday strings. For example: "Sun", "Mon", etc.  An array

     * of 8 strings, indexed by <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc.

     * The element <code>shortWeekdays[0]</code> is ignored.

     * @serial

     */

    String shortWeekdays[] = null;

    /**

     * AM and PM strings. For example: "AM" and "PM".  An array of

     * 2 strings, indexed by <code>Calendar.AM</code> and

     * <code>Calendar.PM</code>.

     * @serial

     */

    String ampms[] = null;

    /**

     * Localized names of time zones in this locale.  This is a

     * two-dimensional array of strings of size <em>n</em> by <em>m</em>,

     * where <em>m</em> is at least 5.  Each of the <em>n</em> rows is an

     * entry containing the localized names for a single <code>TimeZone</code>.

     * Each such row contains (with <code>i</code> ranging from

     * 0..<em>n</em>-1):

     * <ul>

     * <li><code>zoneStrings[i][0]</code> - time zone ID</li>

     * <li><code>zoneStrings[i][1]</code> - long name of zone in standard

     * time</li>

     * <li><code>zoneStrings[i][2]</code> - short name of zone in

     * standard time</li>

     * <li><code>zoneStrings[i][3]</code> - long name of zone in daylight

     * saving time</li>

     * <li><code>zoneStrings[i][4]</code> - short name of zone in daylight

     * saving time</li>

     * </ul>

     * The zone ID is <em>not</em> localized; it's one of the valid IDs of

     * the {@link java.util.TimeZone TimeZone} class that are not

     * <a href="../java/util/TimeZone.html#CustomID">custom IDs</a>.

     * All other entries are localized names.

     * @see java.util.TimeZone

     * @serial

     */

    String zoneStrings[][] = null;

    /**

     * Indicates that zoneStrings is set externally with setZoneStrings() method.

     */

    transient boolean isZoneStringsSet = false;

    /**

     * Unlocalized date-time pattern characters. For example: 'y', 'd', etc.

     * All locales use the same these unlocalized pattern characters.

     */

    static final String  patternChars = "GyMdkHmsSEDFwWahKzZYuX";

    static final int PATTERN_ERA                  =  0; // G

    static final int PATTERN_YEAR                 =  1; // y

    static final int PATTERN_MONTH                =  2; // M

    static final int PATTERN_DAY_OF_MONTH         =  3; // d

    static final int PATTERN_HOUR_OF_DAY1         =  4; // k

    static final int PATTERN_HOUR_OF_DAY0         =  5; // H

    static final int PATTERN_MINUTE               =  6; // m

    static final int PATTERN_SECOND               =  7; // s

    static final int PATTERN_MILLISECOND          =  8; // S

    static final int PATTERN_DAY_OF_WEEK          =  9; // E

    static final int PATTERN_DAY_OF_YEAR          = 10; // D

    static final int PATTERN_DAY_OF_WEEK_IN_MONTH = 11; // F

    static final int PATTERN_WEEK_OF_YEAR         = 12; // w

    static final int PATTERN_WEEK_OF_MONTH        = 13; // W

    static final int PATTERN_AM_PM                = 14; // a

    static final int PATTERN_HOUR1                = 15; // h

    static final int PATTERN_HOUR0                = 16; // K

    static final int PATTERN_ZONE_NAME            = 17; // z

    static final int PATTERN_ZONE_VALUE           = 18; // Z

    static final int PATTERN_WEEK_YEAR            = 19; // Y

    static final int PATTERN_ISO_DAY_OF_WEEK      = 20; // u

    static final int PATTERN_ISO_ZONE             = 21; // X

    /**

     * Localized date-time pattern characters. For example, a locale may

     * wish to use 'u' rather than 'y' to represent years in its date format

     * pattern strings.

     * This string must be exactly 18 characters long, with the index of

     * the characters described by <code>DateFormat.ERA_FIELD</code>,

     * <code>DateFormat.YEAR_FIELD</code>, etc.  Thus, if the string were

     * "Xz...", then localized patterns would use 'X' for era and 'z' for year.

     * @serial

     */

    String  localPatternChars = null;

    /**

     * The locale which is used for initializing this DateFormatSymbols object.

     *

     * @since 1.6

     * @serial

     */

    Locale locale = null;

    /* use serialVersionUID from JDK 1.1.4 for interoperability */

    static final long serialVersionUID = -5987973545549424702L;

    /**

     * Returns an array of all locales for which the

     * <code>getInstance</code> methods of this class can return

     * localized instances.

     * The returned array represents the union of locales supported by the

     * Java runtime and by installed

     * {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}

     * implementations.  It must contain at least a <code>Locale</code>

     * instance equal to {@link java.util.Locale#US Locale.US}.

     *

     * @return An array of locales for which localized

     *         <code>DateFormatSymbols</code> instances are available.

     * @since 1.6

     */

    public static Locale[] getAvailableLocales() {

        LocaleServiceProviderPool pool=

            LocaleServiceProviderPool.getPool(DateFormatSymbolsProvider.class);

        return pool.getAvailableLocales();

    }

    /**

     * Gets the <code>DateFormatSymbols</code> instance for the default

     * locale.  This method provides access to <code>DateFormatSymbols</code>

     * instances for locales supported by the Java runtime itself as well

     * as for those supported by installed

     * {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}

     * implementations.

     * @return a <code>DateFormatSymbols</code> instance.

     * @since 1.6

     */

    public static final DateFormatSymbols getInstance() {

        return getInstance(Locale.getDefault(Locale.Category.FORMAT));

    }

    /**

     * Gets the <code>DateFormatSymbols</code> instance for the specified

     * locale.  This method provides access to <code>DateFormatSymbols</code>

     * instances for locales supported by the Java runtime itself as well

     * as for those supported by installed

     * {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}

     * implementations.

     * @param locale the given locale.

     * @return a <code>DateFormatSymbols</code> instance.

     * @exception NullPointerException if <code>locale</code> is null

     * @since 1.6

     */

    public static final DateFormatSymbols getInstance(Locale locale) {

        DateFormatSymbols dfs = getProviderInstance(locale);

        if (dfs != null) {

            return dfs;

        }

        return (DateFormatSymbols) getCachedInstance(locale).clone();

    }

    /**

     * Returns a DateFormatSymbols provided by a provider or found in

     * the cache. Note that this method returns a cached instance,

     * not its clone. Therefore, the instance should never be given to

     * an application.

     */

    static final DateFormatSymbols getInstanceRef(Locale locale) {

        DateFormatSymbols dfs = getProviderInstance(locale);

        if (dfs != null) {

            return dfs;

        }

        return getCachedInstance(locale);

    }

    private static DateFormatSymbols getProviderInstance(Locale locale) {

        DateFormatSymbols providersInstance = null;

        // Check whether a provider can provide an implementation that's closer

        // to the requested locale than what the Java runtime itself can provide.

        LocaleServiceProviderPool pool =

            LocaleServiceProviderPool.getPool(DateFormatSymbolsProvider.class);

        if (pool.hasProviders()) {

            providersInstance = pool.getLocalizedObject(

                                    DateFormatSymbolsGetter.INSTANCE, locale);

        }

        return providersInstance;

    }

    /**

     * Returns a cached DateFormatSymbols if it's found in the

     * cache. Otherwise, this method returns a newly cached instance

     * for the given locale.

     */

    private static DateFormatSymbols getCachedInstance(Locale locale) {

        SoftReference<DateFormatSymbols> ref = cachedInstances.get(locale);

        DateFormatSymbols dfs = null;

        if (ref == null || (dfs = ref.get()) == null) {

            dfs = new DateFormatSymbols(locale);

            ref = new SoftReference<DateFormatSymbols>(dfs);

            SoftReference<DateFormatSymbols> x = cachedInstances.putIfAbsent(locale, ref);

            if (x != null) {

                DateFormatSymbols y = x.get();

                if (y != null) {

                    dfs = y;

                } else {

                    // Replace the empty SoftReference with ref.

                    cachedInstances.put(locale, ref);

                }

            }

        }

        return dfs;

    }

    /**

     * Gets era strings. For example: "AD" and "BC".

     * @return the era strings.

     */

    public String[] getEras() {

        return Arrays.copyOf(eras, eras.length);

    }

    /**

     * Sets era strings. For example: "AD" and "BC".

     * @param newEras the new era strings.

     */

    public void setEras(String[] newEras) {

        eras = Arrays.copyOf(newEras, newEras.length);

    }

    /**

     * Gets month strings. For example: "January", "February", etc.

     * @return the month strings.

     */

    public String[] getMonths() {

        return Arrays.copyOf(months, months.length);

    }

    /**

     * Sets month strings. For example: "January", "February", etc.

     * @param newMonths the new month strings.

     */

    public void setMonths(String[] newMonths) {

        months = Arrays.copyOf(newMonths, newMonths.length);

    }

    /**

     * Gets short month strings. For example: "Jan", "Feb", etc.

     * @return the short month strings.

     */

    public String[] getShortMonths() {

        return Arrays.copyOf(shortMonths, shortMonths.length);

    }

    /**

     * Sets short month strings. For example: "Jan", "Feb", etc.

     * @param newShortMonths the new short month strings.

     */

    public void setShortMonths(String[] newShortMonths) {

        shortMonths = Arrays.copyOf(newShortMonths, newShortMonths.length);

    }

    /**

     * Gets weekday strings. For example: "Sunday", "Monday", etc.

     * @return the weekday strings. Use <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc. to index the result array.

     */

    public String[] getWeekdays() {

        return Arrays.copyOf(weekdays, weekdays.length);

    }

    /**

     * Sets weekday strings. For example: "Sunday", "Monday", etc.

     * @param newWeekdays the new weekday strings. The array should

     * be indexed by <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc.

     */

    public void setWeekdays(String[] newWeekdays) {

        weekdays = Arrays.copyOf(newWeekdays, newWeekdays.length);

    }

    /**

     * Gets short weekday strings. For example: "Sun", "Mon", etc.

     * @return the short weekday strings. Use <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc. to index the result array.

     */

    public String[] getShortWeekdays() {

        return Arrays.copyOf(shortWeekdays, shortWeekdays.length);

    }

    /**

     * Sets short weekday strings. For example: "Sun", "Mon", etc.

     * @param newShortWeekdays the new short weekday strings. The array should

     * be indexed by <code>Calendar.SUNDAY</code>,

     * <code>Calendar.MONDAY</code>, etc.

     */

    public void setShortWeekdays(String[] newShortWeekdays) {

        shortWeekdays = Arrays.copyOf(newShortWeekdays, newShortWeekdays.length);

    }

    /**

     * Gets ampm strings. For example: "AM" and "PM".

     * @return the ampm strings.

     */

    public String[] getAmPmStrings() {

        return Arrays.copyOf(ampms, ampms.length);

    }

    /**

     * Sets ampm strings. For example: "AM" and "PM".

     * @param newAmpms the new ampm strings.

     */

    public void setAmPmStrings(String[] newAmpms) {

        ampms = Arrays.copyOf(newAmpms, newAmpms.length);

    }

    /**

     * Gets time zone strings.  Use of this method is discouraged; use

     * {@link java.util.TimeZone#getDisplayName() TimeZone.getDisplayName()}

     * instead.

     * <p>

     * The value returned is a

     * two-dimensional array of strings of size <em>n</em> by <em>m</em>,

     * where <em>m</em> is at least 5.  Each of the <em>n</em> rows is an

     * entry containing the localized names for a single <code>TimeZone</code>.

     * Each such row contains (with <code>i</code> ranging from

     * 0..<em>n</em>-1):

     * <ul>

     * <li><code>zoneStrings[i][0]</code> - time zone ID</li>

     * <li><code>zoneStrings[i][1]</code> - long name of zone in standard

     * time</li>

     * <li><code>zoneStrings[i][2]</code> - short name of zone in

     * standard time</li>

     * <li><code>zoneStrings[i][3]</code> - long name of zone in daylight

     * saving time</li>

     * <li><code>zoneStrings[i][4]</code> - short name of zone in daylight

     * saving time</li>

     * </ul>

     * The zone ID is <em>not</em> localized; it's one of the valid IDs of

     * the {@link java.util.TimeZone TimeZone} class that are not

     * <a href="../util/TimeZone.html#CustomID">custom IDs</a>.

     * All other entries are localized names.  If a zone does not implement

     * daylight saving time, the daylight saving time names should not be used.

     * <p>

     * If {@link #setZoneStrings(String[][]) setZoneStrings} has been called

     * on this <code>DateFormatSymbols</code> instance, then the strings

     * provided by that call are returned. Otherwise, the returned array

     * contains names provided by the Java runtime and by installed

     * {@link java.util.spi.TimeZoneNameProvider TimeZoneNameProvider}

     * implementations.

     *