| java.lang.Object
 org.jivesoftware.util.LocaleUtils
| LocaleUtils | | public class LocaleUtils (Code) | | A set of methods for retrieving and converting locale specific strings and numbers.
author:
Jive Software |
| Method Summary | |
| public static String | getLocalizedNumber(long number)
Returns an internationalized String representation of the number using
the default locale.
Parameters:
number - the number to format. | | public static String | getLocalizedNumber(long number, Locale locale)
Returns an internationalized String representation of the number using
the specified locale.
Parameters:
number - the number to format.
Parameters:
locale - the locale to use for formatting. | | public static String | getLocalizedNumber(double number)
Returns an internationalized String representation of the number using
the default locale.
Parameters:
number - the number to format. | | public static String | getLocalizedNumber(double number, Locale locale)
Returns an internationalized String representation of the number using
the specified locale.
Parameters:
number - the number to format.
Parameters:
locale - the locale to use for formatting. | | public static String | getLocalizedString(String key)
Returns an internationalized string loaded from a resource bundle.
The locale used will be the locale specified by JiveGlobals.getLocale().
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle. | | public static String | getLocalizedString(String key, Locale locale)
Returns an internationalized string loaded from a resource bundle using
the passed in Locale.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
locale - the locale to use for retrieving the appropriatelocale-specific string. | | public static String | getLocalizedString(String key, List arguments)
Returns an internationalized string loaded from a resource bundle using
the locale specified by JiveGlobals.getLocale() substituting the passed
in arguments. | | public static String | getLocalizedString(String key, String pluginName)
Returns an internationalized string loaded from a resource bundle from the passed
in plugin. | | public static String | getLocalizedString(String key, String pluginName, List arguments)
Returns an internationalized string loaded from a resource bundle from the passed
in plugin. | | public static String | getLocalizedString(String key, Locale locale, List arguments, ResourceBundle bundle)
Returns an internationalized string loaded from a resource bundle using
the passed in Locale substituting the passed in arguments. | | public static ResourceBundle | getPluginResourceBundle(String pluginName)
Retrieve the ResourceBundle that is used with this plugin.
Parameters:
pluginName - the name of the plugin. | | public static ResourceBundle | getResourceBundle(String baseName, Locale locale)
Returns the specified resource bundle, which is a properties file
that aids in localization of skins. | | public static String[][] | getTimeZoneList()
Returns a list of all available time zone's as a String [][]. | | public static String | getTimeZoneName(String zoneID, Locale locale)
Returns the display name for a time zone. | | public static Locale | localeCodeToLocale(String localeCode)
Converts a locale string like "en", "en_US" or "en_US_win" to a Java
locale object. |
| getLocalizedNumber | | public static String getLocalizedNumber(long number)(Code) | | Returns an internationalized String representation of the number using
the default locale.
Parameters:
number - the number to format. an internationalized String representation of the number. |
| getLocalizedNumber | | public static String getLocalizedNumber(long number, Locale locale)(Code) | | Returns an internationalized String representation of the number using
the specified locale.
Parameters:
number - the number to format.
Parameters:
locale - the locale to use for formatting. an internationalized String representation of the number. |
| getLocalizedNumber | | public static String getLocalizedNumber(double number)(Code) | | Returns an internationalized String representation of the number using
the default locale.
Parameters:
number - the number to format. an internationalized String representation of the number. |
| getLocalizedNumber | | public static String getLocalizedNumber(double number, Locale locale)(Code) | | Returns an internationalized String representation of the number using
the specified locale.
Parameters:
number - the number to format.
Parameters:
locale - the locale to use for formatting. an internationalized String representation of the number. |
| getLocalizedString | | public static String getLocalizedString(String key)(Code) | | Returns an internationalized string loaded from a resource bundle.
The locale used will be the locale specified by JiveGlobals.getLocale().
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle. the localized string. |
| getLocalizedString | | public static String getLocalizedString(String key, Locale locale)(Code) | | Returns an internationalized string loaded from a resource bundle using
the passed in Locale.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
locale - the locale to use for retrieving the appropriatelocale-specific string. the localized string. |
| getLocalizedString | | public static String getLocalizedString(String key, List arguments)(Code) | | Returns an internationalized string loaded from a resource bundle using
the locale specified by JiveGlobals.getLocale() substituting the passed
in arguments. Substitution is handled using the
java.text.MessageFormat class.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
arguments - a list of objects to use which are formatted, theninserted into the pattern at the appropriate places. the localized string. |
| getLocalizedString | | public static String getLocalizedString(String key, String pluginName)(Code) | | Returns an internationalized string loaded from a resource bundle from the passed
in plugin. If the plugin name is null, the key will be looked up using
the standard resource bundle.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
pluginName - the name of the plugin to load the require resource bundle from. the localized string. |
| getLocalizedString | | public static String getLocalizedString(String key, String pluginName, List arguments)(Code) | | Returns an internationalized string loaded from a resource bundle from the passed
in plugin. If the plugin name is null, the key will be looked up using
the standard resource bundle.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
pluginName - the name of the plugin to load the require resource bundle from.
Parameters:
arguments - a list of objects to use which are formatted, theninserted into the pattern at the appropriate places. the localized string. |
| getLocalizedString | | public static String getLocalizedString(String key, Locale locale, List arguments, ResourceBundle bundle)(Code) | | Returns an internationalized string loaded from a resource bundle using
the passed in Locale substituting the passed in arguments. Substitution
is handled using the
MessageFormat class.
Parameters:
key - the key to use for retrieving the string from theappropriate resource bundle.
Parameters:
locale - the locale to use for retrieving the appropriatelocale-specific string.
Parameters:
arguments - a list of objects to use which are formatted, theninserted into the pattern at the appropriate places. the localized string. |
| getPluginResourceBundle | | public static ResourceBundle getPluginResourceBundle(String pluginName) throws Exception(Code) | | Retrieve the ResourceBundle that is used with this plugin.
Parameters:
pluginName - the name of the plugin. the ResourceBundle used with this plugin.
throws:
Exception - thrown if an exception occurs. |
| getResourceBundle | | public static ResourceBundle getResourceBundle(String baseName, Locale locale)(Code) | | Returns the specified resource bundle, which is a properties file
that aids in localization of skins. This method is handy since it
uses the class loader that other Jive classes are loaded from (hence,
it can load bundles that are stored in jive.jar).
Parameters:
baseName - the name of the resource bundle to load.
Parameters:
locale - the desired Locale. the specified resource bundle, if it exists. |
| getTimeZoneList | | public static String[][] getTimeZoneList()(Code) | | Returns a list of all available time zone's as a String [][]. The first
entry in each list item is the timeZoneID, and the second is the
display name.
The list of time zones attempts to be inclusive of all of the worlds
zones while being as concise as possible. For "en" language locales
the name is a friendly english name. For non-"en" language locales
the standard JDK name is used for the given Locale. The GMT+/- time
is also included for readability.
a list of time zones, as a tuple of the zime zone ID, and itsdisplay name. |
| getTimeZoneName | | public static String getTimeZoneName(String zoneID, Locale locale)(Code) | | Returns the display name for a time zone. The display name is the name
specified by the Java TimeZone class for non-"en" locales or a friendly english
name for "en", with the addition of the GMT offset
for human readability.
Parameters:
zoneID - the time zone to get the name for.
Parameters:
locale - the locale to use. the display name for the time zone. |
| localeCodeToLocale | | public static Locale localeCodeToLocale(String localeCode)(Code) | | Converts a locale string like "en", "en_US" or "en_US_win" to a Java
locale object. If the conversion fails, null is returned.
Parameters:
localeCode - the locale code for a Java locale. See the java.util.Localeclass for more details. |
|
|