- java.lang.Object
-
- javax.servlet.jsp.jstl.fmt.LocaleSupport
-
public class LocaleSupport extends Object
Class which exposes the locale-determination logic for resource bundles through convenience methods.This class may be useful to any tag handler implementation that needs to produce localized messages. For example, this might be useful for exception messages that are intended directly for user consumption on an error page.
- Author:
- Jan Luehe
-
-
Constructor Summary
Constructors Constructor and Description LocaleSupport()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static String
getLocalizedMessage(PageContext pageContext, String key)
Retrieves the localized message corresponding to the given key.static String
getLocalizedMessage(PageContext pageContext, String key, Object[] args)
Retrieves the localized message corresponding to the given key, and performs parametric replacement using the arguments specified via args.static String
getLocalizedMessage(PageContext pageContext, String key, Object[] args, String basename)
Retrieves the localized message corresponding to the given key, and performs parametric replacement using the arguments specified via args.static String
getLocalizedMessage(PageContext pageContext, String key, String basename)
Retrieves the localized message corresponding to the given key.
-
-
-
Method Detail
-
getLocalizedMessage
public static String getLocalizedMessage(PageContext pageContext, String key)
Retrieves the localized message corresponding to the given key.The given key is looked up in the resource bundle of the default I18N localization context, which is retrieved from the javax.servlet.jsp.jstl.fmt.localizationContext configuration setting.
If the configuration setting is empty, or the default I18N localization context does not contain any resource bundle, or the given key is undefined in its resource bundle, the string "???<key>???" is returned, where "<key>" is replaced with the given key.
- Parameters:
pageContext
- the page in which to get the localized message corresponding to the given keykey
- the message key- Returns:
- the localized message corresponding to the given key
-
getLocalizedMessage
public static String getLocalizedMessage(PageContext pageContext, String key, String basename)
Retrieves the localized message corresponding to the given key.The given key is looked up in the resource bundle with the given base name.
If no resource bundle with the given base name exists, or the given key is undefined in the resource bundle, the string "???<key>???" is returned, where "<key>" is replaced with the given key.
- Parameters:
pageContext
- the page in which to get the localized message corresponding to the given keykey
- the message keybasename
- the resource bundle base name- Returns:
- the localized message corresponding to the given key
-
getLocalizedMessage
public static String getLocalizedMessage(PageContext pageContext, String key, Object[] args)
Retrieves the localized message corresponding to the given key, and performs parametric replacement using the arguments specified via args.See the specification of the <fmt:message> action for a description of how parametric replacement is implemented.
The localized message is retrieved as in
getLocalizedMessage(pageContext, key)
.- Parameters:
pageContext
- the page in which to get the localized message corresponding to the given keykey
- the message keyargs
- the arguments for parametric replacement- Returns:
- the localized message corresponding to the given key
-
getLocalizedMessage
public static String getLocalizedMessage(PageContext pageContext, String key, Object[] args, String basename)
Retrieves the localized message corresponding to the given key, and performs parametric replacement using the arguments specified via args.See the specification of the <fmt:message> action for a description of how parametric replacement is implemented.
The localized message is retrieved as in
getLocalizedMessage(pageContext, key, basename)
.- Parameters:
pageContext
- the page in which to get the localized message corresponding to the given keykey
- the message keyargs
- the arguments for parametric replacementbasename
- the resource bundle base name- Returns:
- the localized message corresponding to the given key
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/jsp/jstl/fmt/localesupport.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.