/*
 *   
 *
 * Copyright  1990-2007 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program 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.
 * 
 * This program 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 at /legal/license.txt).
 * 
 * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 */
package com.sun.j2me.global;

/**
 * This class customizes the {@link javax.microedition.global.Formatter}
 * implementation to rely on platform string comparison capabilities.
 */
public class FormatAbstractionLayerImpl extends FormatAbstractionLayer {

    /**
     * Create instance of <code>FormatAbstractionLayerImpl</code>. This
     * constructor is necessary because of <code>Class.forName()</code> creation
     * call in {@link com.sun.j2me.global.FormatAbstractionLayer#getInstance}.
     */
    public FormatAbstractionLayerImpl() { }

    /**
     * Returns an instance of the <code>FormatterImpl</code> class which
     * realizes most of <code>Formatter</code> methods in platform-specific way.
     *
     * @param locale  the locale to use with this <code>FormatterImpl</code>
     * @return the instance of the <code>FormatterImpl</code>
     */
    public CommonFormatter getFormatter(String locale) {
        return new FormatterImpl(locale);
    }

    /**
     * Gets the list of the locales supported by the formatter, as an array of
     * valid <code>microedition.locale</code> values.<p>
     *
     * If no locales are supported, the list MUST be empty. It MUST NOT be
     * <code>null</code>. As the value <code>null</code> is not technically a
     * valid locale, but a special value to trigger locale-neutral formatting,
     * it MUST NOT appear in the array.
     *
     * @return    an array of strings containing the locale values
     */
    public String[] getSupportedLocales() {

        int lcount = getFormatLocalesCount();
		if (lcount == 0) return new String[0];

		int index = 0;

		String locale = getFormatLocaleName(0);
		if (locale == null || locale.equals("")){
			index = 1;
		}

        String[] locales = new String[lcount-index];
        for (int i=0; index < lcount; index++) {
            locales[i++] = getFormatLocaleName(index);
        }

        return locales;
    }

    /**
     * Get number of supported locales for data formatting.
     *
     * @return           number of locales
     */
    public static native int getFormatLocalesCount();

    /**
     * Get one of supported locales (by number).
     *
     * @param  index     index of locale to select
     * @return           locale
     */
    public static native String getFormatLocaleName(int index);

    /**
     * Get index of supported locales for formatter by its name.
     *
	 * @param  locale    name of locale
     * @return           index of locale
     */
    public static native int getFormatLocaleIndex(String locale);

}