/*

 * Copyright (c) 1996, 2019, 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, 1997 - All Rights Reserved

 * (C) Copyright IBM Corp. 1996 - 1998 - 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.InvalidObjectException;

import java.io.IOException;

import java.io.ObjectInputStream;

import java.io.Serializable;

import java.text.spi.DecimalFormatSymbolsProvider;

import java.util.Currency;

import java.util.Locale;

import java.util.Objects;

import sun.util.locale.provider.CalendarDataUtility;

import sun.util.locale.provider.LocaleProviderAdapter;

import sun.util.locale.provider.LocaleServiceProviderPool;

import sun.util.locale.provider.ResourceBundleBasedAdapter;

/**

 * This class represents the set of symbols (such as the decimal separator,

 * the grouping separator, and so on) needed by {@code DecimalFormat}

 * to format numbers. {@code DecimalFormat} creates for itself an instance of

 * {@code DecimalFormatSymbols} from its locale data.  If you need to change any

 * of these symbols, you can get the {@code DecimalFormatSymbols} object from

 * your {@code DecimalFormat} and modify it.

 *

 * <p>If the locale contains "rg" (region override)

 * <a href="../util/Locale.html#def_locale_extension">Unicode extension</a>,

 * the symbols are overridden for the designated region.

 *

 * @see          java.util.Locale

 * @see          DecimalFormat

 * @author       Mark Davis

 * @author       Alan Liu

 * @since 1.1

 */

public class DecimalFormatSymbols implements Cloneable, Serializable {

    /**

     * Create a DecimalFormatSymbols object for the default

     * {@link java.util.Locale.Category#FORMAT FORMAT} 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.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider}

     * implementations. For full locale coverage, use the

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

     * <p>This is equivalent to calling

     * {@link #DecimalFormatSymbols(Locale)

     *     DecimalFormatSymbols(Locale.getDefault(Locale.Category.FORMAT))}.

     * @see java.util.Locale#getDefault(java.util.Locale.Category)

     * @see java.util.Locale.Category#FORMAT

     */

    public DecimalFormatSymbols() {

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

    }

    /**

     * Create a DecimalFormatSymbols object 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.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider}

     * implementations. For full locale coverage, use the

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

     * If the specified locale contains the {@link java.util.Locale#UNICODE_LOCALE_EXTENSION}

     * for the numbering system, the instance is initialized with the specified numbering

     * system if the JRE implementation supports it. For example,

     * <pre>

     * NumberFormat.getNumberInstance(Locale.forLanguageTag("th-TH-u-nu-thai"))

     * </pre>

     * This may return a {@code NumberFormat} instance with the Thai numbering system,

     * instead of the Latin numbering system.

     *

     * @param locale the desired locale

     * @throws    NullPointerException if {@code locale} is null

     */

    public DecimalFormatSymbols( Locale locale ) {

        initialize( locale );

    }

    /**

     * Returns an array of all locales for which the

     * {@code getInstance} 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.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider}

     * implementations.  It must contain at least a {@code Locale}

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

     *

     * @return an array of locales for which localized

     *         {@code DecimalFormatSymbols} instances are available.

     * @since 1.6

     */

    public static Locale[] getAvailableLocales() {

        LocaleServiceProviderPool pool =

            LocaleServiceProviderPool.getPool(DecimalFormatSymbolsProvider.class);

        return pool.getAvailableLocales();

    }

    /**

     * Gets the {@code DecimalFormatSymbols} instance for the default

     * locale.  This method provides access to {@code DecimalFormatSymbols}

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

     * as for those supported by installed

     * {@link java.text.spi.DecimalFormatSymbolsProvider

     * DecimalFormatSymbolsProvider} implementations.

     * <p>This is equivalent to calling

     * {@link #getInstance(Locale)

     *     getInstance(Locale.getDefault(Locale.Category.FORMAT))}.

     * @see java.util.Locale#getDefault(java.util.Locale.Category)

     * @see java.util.Locale.Category#FORMAT

     * @return a {@code DecimalFormatSymbols} instance.

     * @since 1.6

     */

    public static final DecimalFormatSymbols getInstance() {

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

    }

    /**

     * Gets the {@code DecimalFormatSymbols} instance for the specified

     * locale.  This method provides access to {@code DecimalFormatSymbols}

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

     * as for those supported by installed

     * {@link java.text.spi.DecimalFormatSymbolsProvider

     * DecimalFormatSymbolsProvider} implementations.

     * If the specified locale contains the {@link java.util.Locale#UNICODE_LOCALE_EXTENSION}

     * for the numbering system, the instance is initialized with the specified numbering

     * system if the JRE implementation supports it. For example,

     * <pre>

     * NumberFormat.getNumberInstance(Locale.forLanguageTag("th-TH-u-nu-thai"))

     * </pre>

     * This may return a {@code NumberFormat} instance with the Thai numbering system,

     * instead of the Latin numbering system.

     *

     * @param locale the desired locale.

     * @return a {@code DecimalFormatSymbols} instance.

     * @throws    NullPointerException if {@code locale} is null

     * @since 1.6

     */

    public static final DecimalFormatSymbols getInstance(Locale locale) {

        LocaleProviderAdapter adapter;

        adapter = LocaleProviderAdapter.getAdapter(DecimalFormatSymbolsProvider.class, locale);

        DecimalFormatSymbolsProvider provider = adapter.getDecimalFormatSymbolsProvider();

        DecimalFormatSymbols dfsyms = provider.getInstance(locale);

        if (dfsyms == null) {

            provider = LocaleProviderAdapter.forJRE().getDecimalFormatSymbolsProvider();

            dfsyms = provider.getInstance(locale);

        }

        return dfsyms;

    }

    /**

     * Gets the character used for zero. Different for Arabic, etc.

     *

     * @return the character used for zero

     */

    public char getZeroDigit() {

        return zeroDigit;

    }

    /**

     * Sets the character used for zero. Different for Arabic, etc.

     *

     * @param zeroDigit the character used for zero

     */

    public void setZeroDigit(char zeroDigit) {

        this.zeroDigit = zeroDigit;

    }

    /**

     * Gets the character used for thousands separator. Different for French, etc.

     *

     * @return the grouping separator

     */

    public char getGroupingSeparator() {

        return groupingSeparator;

    }

    /**

     * Sets the character used for thousands separator. Different for French, etc.

     *

     * @param groupingSeparator the grouping separator

     */

    public void setGroupingSeparator(char groupingSeparator) {

        this.groupingSeparator = groupingSeparator;

    }

    /**

     * Gets the character used for decimal sign. Different for French, etc.

     *

     * @return the character used for decimal sign

     */

    public char getDecimalSeparator() {

        return decimalSeparator;

    }

    /**

     * Sets the character used for decimal sign. Different for French, etc.

     *

     * @param decimalSeparator the character used for decimal sign

     */

    public void setDecimalSeparator(char decimalSeparator) {

        this.decimalSeparator = decimalSeparator;

    }

    /**

     * Gets the character used for per mille sign. Different for Arabic, etc.

     *

     * @return the character used for per mille sign

     */

    public char getPerMill() {

        return perMill;

    }

    /**

     * Sets the character used for per mille sign. Different for Arabic, etc.

     *

     * @param perMill the character used for per mille sign

     */

    public void setPerMill(char perMill) {

        this.perMill = perMill;

        this.perMillText = Character.toString(perMill);

    }

    /**

     * Gets the string used for per mille sign. Different for Arabic, etc.

     *

     * @return the string used for per mille sign

     * @since 13

     */

    String getPerMillText() {

        return perMillText;

    }

    /**

     * Sets the string used for per mille sign. Different for Arabic, etc.

     *

     * Setting the {@code perMillText} affects the return value of

     * {@link #getPerMill()}, in which the first non-format character of

     * {@code perMillText} is returned.

     *

     * @param perMillText the string used for per mille sign

     * @throws NullPointerException if {@code perMillText} is null

     * @throws IllegalArgumentException if {@code perMillText} is an empty string

     * @see #getPerMill()

     * @see #getPerMillText()

     * @since 13

     */

    void setPerMillText(String perMillText) {

        Objects.requireNonNull(perMillText);

        if (perMillText.isEmpty()) {

            throw new IllegalArgumentException("Empty argument string");

        }

        this.perMillText = perMillText;

        this.perMill = findNonFormatChar(perMillText, '\u2030');

    }

    /**

     * Gets the character used for percent sign. Different for Arabic, etc.

     *

     * @return the character used for percent sign

     */

    public char getPercent() {

        return percent;

    }

    /**

     * Sets the character used for percent sign. Different for Arabic, etc.

     *

     * @param percent the character used for percent sign

     */

    public void setPercent(char percent) {

        this.percent = percent;

        this.percentText = Character.toString(percent);

    }

    /**

     * Gets the string used for percent sign. Different for Arabic, etc.

     *

     * @return the string used for percent sign

     * @since 13

     */

    String getPercentText() {

        return percentText;

    }

    /**

     * Sets the string used for percent sign. Different for Arabic, etc.

     *

     * Setting the {@code percentText} affects the return value of

     * {@link #getPercent()}, in which the first non-format character of

     * {@code percentText} is returned.

     *

     * @param percentText the string used for percent sign

     * @throws NullPointerException if {@code percentText} is null

     * @throws IllegalArgumentException if {@code percentText} is an empty string

     * @see #getPercent()

     * @see #getPercentText()

     * @since 13

     */

    void setPercentText(String percentText) {

        Objects.requireNonNull(percentText);

        if (percentText.isEmpty()) {

            throw new IllegalArgumentException("Empty argument string");

        }

        this.percentText = percentText;

        this.percent = findNonFormatChar(percentText, '%');

    }

    /**

     * Gets the character used for a digit in a pattern.

     *

     * @return the character used for a digit in a pattern

     */

    public char getDigit() {

        return digit;

    }

    /**

     * Sets the character used for a digit in a pattern.

     *

     * @param digit the character used for a digit in a pattern

     */

    public void setDigit(char digit) {

        this.digit = digit;

    }

    /**

     * Gets the character used to separate positive and negative subpatterns

     * in a pattern.

     *

     * @return the pattern separator

     */

    public char getPatternSeparator() {

        return patternSeparator;

    }

    /**

     * Sets the character used to separate positive and negative subpatterns

     * in a pattern.

     *

     * @param patternSeparator the pattern separator

     */

    public void setPatternSeparator(char patternSeparator) {

        this.patternSeparator = patternSeparator;

    }

    /**

     * Gets the string used to represent infinity. Almost always left

     * unchanged.

     *

     * @return the string representing infinity

     */

    public String getInfinity() {

        return infinity;

    }

    /**

     * Sets the string used to represent infinity. Almost always left

     * unchanged.

     *

     * @param infinity the string representing infinity

     */

    public void setInfinity(String infinity) {

        this.infinity = infinity;

    }

    /**

     * Gets the string used to represent "not a number". Almost always left

     * unchanged.

     *

     * @return the string representing "not a number"

     */

    public String getNaN() {

        return NaN;

    }

    /**

     * Sets the string used to represent "not a number". Almost always left

     * unchanged.

     *

     * @param NaN the string representing "not a number"

     */

    public void setNaN(String NaN) {

        this.NaN = NaN;

    }

    /**

     * Gets the character used to represent minus sign. If no explicit

     * negative format is specified, one is formed by prefixing

     * minusSign to the positive format.

     *

     * @return the character representing minus sign

     */

    public char getMinusSign() {

        return minusSign;

    }

    /**

     * Sets the character used to represent minus sign. If no explicit

     * negative format is specified, one is formed by prefixing

     * minusSign to the positive format.

     *

     * @param minusSign the character representing minus sign

     */

    public void setMinusSign(char minusSign) {

        this.minusSign = minusSign;

        this.minusSignText = Character.toString(minusSign);

    }

    /**

     * Gets the string used to represent minus sign. If no explicit

     * negative format is specified, one is formed by prefixing

     * minusSignText to the positive format.

     *

     * @return the string representing minus sign

     * @since 13

     */

    String getMinusSignText() {

        return minusSignText;

    }

    /**

     * Sets the string used to represent minus sign. If no explicit

     * negative format is specified, one is formed by prefixing

     * minusSignText to the positive format.

     *

     * Setting the {@code minusSignText} affects the return value of

     * {@link #getMinusSign()}, in which the first non-format character of

     * {@code minusSignText} is returned.

     *

     * @param minusSignText the character representing minus sign

     * @throws NullPointerException if {@code minusSignText} is null

     * @throws IllegalArgumentException if {@code minusSignText} is an

     *  empty string

     * @see #getMinusSign()

     * @see #getMinusSignText()

     * @since 13

     */

    void setMinusSignText(String minusSignText) {

        Objects.requireNonNull(minusSignText);

        if (minusSignText.isEmpty()) {

            throw new IllegalArgumentException("Empty argument string");

        }

        this.minusSignText = minusSignText;

        this.minusSign = findNonFormatChar(minusSignText, '-');

    }

    /**

     * Returns the currency symbol for the currency of these

     * DecimalFormatSymbols in their locale.

     *

     * @return the currency symbol

     * @since 1.2

     */

    public String getCurrencySymbol()

    {

        initializeCurrency(locale);

        return currencySymbol;

    }

    /**

     * Sets the currency symbol for the currency of these

     * DecimalFormatSymbols in their locale.

     *