Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

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

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * 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 for more details.

 *

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

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.i18n;

import java.io.File;

import java.util.List;

import java.util.Locale;

public interface I18nManager {

        /**

         * Get translation for the current language of <b>message</b>.

         * 

         * If the translation not found return the message it self.

         * 

         * @param message

         *          the message key used for translation.

         * 

         * @return the traslated message

         */

        public String getTranslation(String message);

        /**

         * Get translation for the current language of <b>message</b>.

         * This use the java MessageFormat utiity to replace args in the

         * resulting translation message.

         * 

         * If the translation not found return the message it self.

         * 

         * @param message

         *          the message key used for translation.

         * 

         * @param args

         * @return the traslated message

         */

        public String getTranslation(String message, String[] args);

        public void addResourceFamily(String family, ClassLoader loader, String callerName);

        /**

         * Adds an additional family of resource files containing some translations.

         * The search path to locate the files is provided by the dir parameter.

         *

         * Example:

         *   <code>i18nManager.addResourceFamily("text", new File("./resources"))</code>

         * 

         * @param family    The family name (or base name) which is used to search

         *                  actual properties files.

         * @param folder    The search path to locate the property files

         */

        public void addResourceFamily(String family, File folder);

        public List<Locale> getPreferredLocales();

        public Locale getCurrentLocale();

}