gnu.java.locale

Class LocaleHelper


public class LocaleHelper
extends Object

This class provides common helper methods for handling localized data.
See Also:
Locale, ResourceBundle

Method Summary

static String
getLocalizedString(Locale inLocale, String key, String name, boolean checkEnglish, boolean checkRoot)
This method is used by the localized name lookup methods to retrieve the localized name of a particular piece of locale data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getLocalizedString

public static String getLocalizedString(Locale inLocale,
                                        String key,
                                        String name,
                                        boolean checkEnglish,
                                        boolean checkRoot)
This method is used by the localized name lookup methods to retrieve the localized name of a particular piece of locale data. If the display name can not be localized to the supplied locale, it will fall back on other output in the following order:
  • the localized name in the default locale
  • the localized name in English (optional)
  • the localized name in the root locale bundle (optional)
  • the localized input string

If the supplied key is merely the empty string, then the empty string is returned.

Parameters:
inLocale - the locale to use for formatting the display string.
key - the locale data used as a key to the localized lookup tables.
name - the name of the hashtable containing the localized data.
checkEnglish - true if the method should fall back on data from the English locale.
checkRoot - true if the method should fall back on data from the unlocalized root locale.
Returns:
a String, hopefully containing the localized variant of the input data.
Throws:
NullPointerException - if inLocale is null.

LocaleHelper.java -- helper routines for localization Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath 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, or (at your option) any later version. GNU Classpath 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 GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.