Package org.apache.myfaces.util
Class MessageUtils
java.lang.Object
org.apache.myfaces.util.MessageUtils
Utility class to support multilingual FacesMessages using ResourceBundles.
Standard messages are stored at
The summary of the message is stored at the requested key value. The detail of the message is stored at <messageId>_detail.
DEFAULT_BUNDLE
.The summary of the message is stored at the requested key value. The detail of the message is stored at <messageId>_detail.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
addMessage
(FacesMessage.Severity severity, String messageId, Object[] args) static void
addMessage
(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) static void
addMessage
(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) static void
addMessage
(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) static void
addMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) static void
addMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) static void
addMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) static void
addMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) static Locale
static Locale
getCurrentLocale
(FacesContext context) static Object
getLabel
(FacesContext facesContext, UIComponent component) static FacesMessage
getMessage
(FacesMessage.Severity severity, String messageId, Object arg) static FacesMessage
getMessage
(FacesMessage.Severity severity, String messageId, Object[] args) static FacesMessage
getMessage
(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) static FacesMessage
getMessage
(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object[] params) static FacesMessage
getMessage
(FacesContext context, String messageId) static FacesMessage
getMessage
(FacesContext context, String messageId, Object[] params) static FacesMessage
getMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object arg) static FacesMessage
getMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) static FacesMessage
getMessage
(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) static FacesMessage
getMessage
(String bundleBaseName, FacesContext context, String messageId) static FacesMessage
getMessage
(String bundleBaseName, FacesContext context, String messageId, Object[] params) static FacesMessage
getMessage
(String messageId, Object[] params) static FacesMessage
getMessage
(String bundleBaseName, String messageId, Object[] params) Retrieve the message from a specific bundle.static FacesMessage
getMessage
(String bundleBaseName, Locale locale, String messageId, Object[] params) Retrieve the message from a specific bundle.static FacesMessage
getMessage
(Locale locale, String messageId, Object[] params) static FacesMessage
getMessage
(ResourceBundle bundle, String messageId, Object[] params) static FacesMessage
getMessageFromBundle
(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object[] params) static FacesMessage
getMessageFromBundle
(String bundleBaseName, String messageId, Object[] params) static String
substituteParams
(Locale locale, String msgtext, Object[] params) UsesMessageFormat
and the supplied parameters to fill in the param placeholders in the String.
-
Method Details
-
getMessage
- Parameters:
severity
- serverity of messagemessageId
- id of messagearg
- arument of message- Returns:
- generated FacesMessage
-
getMessage
public static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object arg) -
getMessage
public static FacesMessage getMessage(FacesMessage.Severity severity, String messageId, Object[] args) - Parameters:
severity
- serverity of messagemessageId
- id of messageargs
- aruments of message- Returns:
- generated FacesMessage
-
getMessage
public static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) -
getMessage
public static FacesMessage getMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) -
getMessage
public static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) -
addMessage
-
addMessage
public static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) -
addMessage
public static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) -
addMessage
public static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) -
addMessage
public static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) -
addMessage
public static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) -
addMessage
public static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) -
addMessage
public static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) -
substituteParams
UsesMessageFormat
and the supplied parameters to fill in the param placeholders in the String.- Parameters:
locale
- TheLocale
to use when performing the substitution.msgtext
- The original parameterized String.params
- The params to fill in the String with.- Returns:
- The updated String.
-
getMessage
-
getMessageFromBundle
public static FacesMessage getMessageFromBundle(String bundleBaseName, String messageId, Object[] params) -
getMessage
-
getMessageFromBundle
public static FacesMessage getMessageFromBundle(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object[] params) -
getMessage
Retrieve the message from a specific bundle. It does not look on application message bundle or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead- Parameters:
bundleBaseName
- baseName of ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message- Returns:
- generated FacesMessage
-
getCurrentLocale
- Returns:
- currently applicable Locale for this request.
-
getCurrentLocale
-
getMessage
public static FacesMessage getMessage(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object[] params) - Parameters:
severity
- severity of messagebundleBaseName
- baseName of ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message- Returns:
- generated FacesMessage
-
getMessage
public static FacesMessage getMessage(String bundleBaseName, Locale locale, String messageId, Object[] params) Retrieve the message from a specific bundle. It does not look on application message bundle or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead- Parameters:
bundleBaseName
- baseName of ResourceBundle to load localized messageslocale
- current localemessageId
- id of messageparams
- parameters to set at localized message- Returns:
- generated FacesMessage
-
getMessage
- Parameters:
bundle
- ResourceBundle to load localized messagesmessageId
- id of messageparams
- parameters to set at localized message- Returns:
- generated FacesMessage
-
getMessage
- Parameters:
context
-messageId
-- Returns:
- generated FacesMessage
-
getMessage
public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId) -
getMessage
- Parameters:
context
-messageId
-params
-- Returns:
- generated FacesMessage
-
getMessage
public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId, Object[] params) -
getLabel
-