Package org.castor.core.util
Class Messages
java.lang.Object
org.castor.core.util.Messages
I18N message formatting class. A static factory for obtaining
messages and formatting messages with arguments.
The resource file org.exolab.castor.util.resources.messages contains a list of all the messages in English. Additional resource files can be added for other languages and locales by placing them in the same package with a language/locale prefix. See the I18N documentation and use of resource bundles in the JDK docs.
- Since:
- 1.0.1
- Version:
- $Revision: 6907 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $
- Author:
- Assaf Arkin, Ralf Joachim
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The name of the resource holding all the messages in the English language. -
Method Summary
Modifier and TypeMethodDescriptionstatic String
Format the named message using a single argument and return the full message text.static String
Format the named message using any number of arguments and return the full message text.static String
Format the named message using two argument and return the full message text.static String
Format the named message using three argument and return the full message text.static String
Return the text of the named message without formatting.static void
Set the default locale to use for loading messages.static void
Set the locale to use for loading messages.
-
Field Details
-
RESOURCE_NAME
The name of the resource holding all the messages in the English language. Resources for other languages and locales use the same name with a language/locale prefix.- See Also:
-
-
Method Details
-
setDefaultLocale
public static void setDefaultLocale()Set the default locale to use for loading messages. Calling this method will reload all the messages based on the new locale name. -
setLocale
Set the locale to use for loading messages. Calling this method will reload all the messages based on the new locale name.- Parameters:
locale
- the locale for which a resource bundle is desired.
-
format
Format the named message using a single argument and return the full message text.- Parameters:
message
- The message namearg1
- The first argument- Returns:
- The full message text
-
format
Format the named message using two argument and return the full message text.- Parameters:
message
- The message namearg1
- The first argumentarg2
- The second argument- Returns:
- The full message text
-
format
Format the named message using three argument and return the full message text.- Parameters:
message
- The message namearg1
- The first argumentarg2
- The second argumentarg3
- The third argument- Returns:
- The full message text
-
format
Format the named message using any number of arguments and return the full message text.- Parameters:
message
- The message nameargs
- Argument list- Returns:
- The full message text
-
message
Return the text of the named message without formatting.- Parameters:
message
- The message name- Returns:
- The full message text
-