Package org.apache.myfaces.util
Class MessageUtils
- java.lang.Object
- 
- org.apache.myfaces.util.MessageUtils
 
- 
 public final class MessageUtils extends Object Utility class to support multilingual FacesMessages using ResourceBundles. Standard messages are stored atDEFAULT_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:
- FacesMessage,- ResourceBundle
 
- 
- 
Method SummaryAll Methods Static Methods Concrete Methods Modifier and Type Method Description static voidaddMessage(FacesMessage.Severity severity, String messageId, Object[] args)static voidaddMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext)static voidaddMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId)static voidaddMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext)static voidaddMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args)static voidaddMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext)static voidaddMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId)static voidaddMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext)static LocalegetCurrentLocale()static LocalegetCurrentLocale(FacesContext context)static ObjectgetLabel(FacesContext facesContext, UIComponent component)static FacesMessagegetMessage(FacesMessage.Severity severity, String messageId, Object arg)static FacesMessagegetMessage(FacesMessage.Severity severity, String messageId, Object[] args)static FacesMessagegetMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext)static FacesMessagegetMessage(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object[] params)static FacesMessagegetMessage(FacesContext context, String messageId)static FacesMessagegetMessage(FacesContext context, String messageId, Object[] params)static FacesMessagegetMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object arg)static FacesMessagegetMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args)static FacesMessagegetMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext)static FacesMessagegetMessage(String bundleBaseName, FacesContext context, String messageId)static FacesMessagegetMessage(String bundleBaseName, FacesContext context, String messageId, Object[] params)static FacesMessagegetMessage(String messageId, Object[] params)static FacesMessagegetMessage(String bundleBaseName, String messageId, Object[] params)Retrieve the message from a specific bundle.static FacesMessagegetMessage(String bundleBaseName, Locale locale, String messageId, Object[] params)Retrieve the message from a specific bundle.static FacesMessagegetMessage(Locale locale, String messageId, Object[] params)static FacesMessagegetMessage(ResourceBundle bundle, String messageId, Object[] params)static FacesMessagegetMessageFromBundle(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object[] params)static FacesMessagegetMessageFromBundle(String bundleBaseName, String messageId, Object[] params)static StringsubstituteParams(Locale locale, String msgtext, Object[] params)UsesMessageFormatand the supplied parameters to fill in the param placeholders in the String.
 
- 
- 
- 
Method Detail- 
getMessagepublic static FacesMessage getMessage(FacesMessage.Severity severity, String messageId, Object arg) - Parameters:
- severity- serverity of message
- messageId- id of message
- arg- arument of message
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object arg) 
 - 
getMessagepublic static FacesMessage getMessage(FacesMessage.Severity severity, String messageId, Object[] args) - Parameters:
- severity- serverity of message
- messageId- id of message
- args- aruments of message
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) 
 - 
getMessagepublic static FacesMessage getMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) 
 - 
addMessagepublic static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args) 
 - 
addMessagepublic static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args) 
 - 
addMessagepublic static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) 
 - 
addMessagepublic static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, FacesContext facesContext) 
 - 
addMessagepublic static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) 
 - 
addMessagepublic static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId) 
 - 
addMessagepublic static void addMessage(FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) 
 - 
addMessagepublic static void addMessage(String bundleBaseName, FacesMessage.Severity severity, String messageId, Object[] args, String forClientId, FacesContext facesContext) 
 - 
substituteParamspublic static String substituteParams(Locale locale, String msgtext, Object[] params) UsesMessageFormatand the supplied parameters to fill in the param placeholders in the String.- Parameters:
- locale- The- Localeto use when performing the substitution.
- msgtext- The original parameterized String.
- params- The params to fill in the String with.
- Returns:
- The updated String.
 
 - 
getMessagepublic static FacesMessage getMessage(String messageId, Object[] params) 
 - 
getMessageFromBundlepublic static FacesMessage getMessageFromBundle(String bundleBaseName, String messageId, Object[] params) 
 - 
getMessagepublic static FacesMessage getMessage(Locale locale, String messageId, Object[] params) 
 - 
getMessageFromBundlepublic static FacesMessage getMessageFromBundle(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object[] params) 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, 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 messages
- messageId- id of message
- params- parameters to set at localized message
- Returns:
- generated FacesMessage
 
 - 
getCurrentLocalepublic static Locale getCurrentLocale() - Returns:
- currently applicable Locale for this request.
 
 - 
getCurrentLocalepublic static Locale getCurrentLocale(FacesContext context) 
 - 
getMessagepublic static FacesMessage getMessage(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object[] params) - Parameters:
- severity- severity of message
- bundleBaseName- baseName of ResourceBundle to load localized messages
- messageId- id of message
- params- parameters to set at localized message
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic 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 messages
- locale- current locale
- messageId- id of message
- params- parameters to set at localized message
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(ResourceBundle bundle, String messageId, Object[] params) - Parameters:
- bundle- ResourceBundle to load localized messages
- messageId- id of message
- params- parameters to set at localized message
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(FacesContext context, String messageId) - Parameters:
- context-
- messageId-
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId) 
 - 
getMessagepublic static FacesMessage getMessage(FacesContext context, String messageId, Object[] params) - Parameters:
- context-
- messageId-
- params-
- Returns:
- generated FacesMessage
 
 - 
getMessagepublic static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId, Object[] params) 
 - 
getLabelpublic static Object getLabel(FacesContext facesContext, UIComponent component) 
 
- 
 
-