public class PerforceMessages
extends java.lang.Object
Additionally, this class provides a convenient way to format messages with parameters.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MESSAGE_BUNDLE
Default name of the Perforce message bundle properties file.
|
Constructor and Description |
---|
PerforceMessages()
Instantiates a new perforce messages using the default message bundle
properties file package path name .
|
PerforceMessages(java.util.Locale locale)
Instantiates a new perforce messages.
|
PerforceMessages(java.lang.String propertiesFile)
Instantiates a new perforce messages base on the passed-in message bundle
properties file package path name.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
format(java.lang.String message,
java.lang.Object[] params)
Format a message with parameters.
|
java.util.Locale |
getLocale()
Gets the locale.
|
java.lang.String |
getMessage(java.lang.String key)
Gets the message.
|
java.lang.String |
getMessage(java.lang.String key,
java.lang.Object[] params)
Gets the message.
|
java.util.ResourceBundle |
getMessages()
Gets the messages.
|
void |
setLocale(java.util.Locale locale)
Sets the locale.
|
void |
setMessages(java.util.ResourceBundle messages)
Sets the messages.
|
public static final java.lang.String MESSAGE_BUNDLE
public PerforceMessages()
public PerforceMessages(java.lang.String propertiesFile)
propertiesFile
- the name (without the extension) of the properties file
including the full package path name (i.e.
com.perforce.p4java.messages.PerforceMessages)public PerforceMessages(java.util.Locale locale)
locale
- the localepublic java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
locale
- the new localepublic java.util.ResourceBundle getMessages()
public void setMessages(java.util.ResourceBundle messages)
messages
- the new messagespublic java.lang.String getMessage(java.lang.String key)
key
- the keypublic java.lang.String getMessage(java.lang.String key, java.lang.Object[] params)
key
- the keyparams
- the paramspublic java.lang.String format(java.lang.String message, java.lang.Object[] params)
message
- the messageparams
- the paramsMessageFormat