|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.rse.services.clientserver.messages.SystemMessage
org.eclipse.rse.services.clientserver.messages.SimpleSystemMessage
public class SimpleSystemMessage
An RSE SystemMessage that can be created from Strings (without XML parsing).
Field Summary |
---|
Fields inherited from class org.eclipse.rse.services.clientserver.messages.SystemMessage |
---|
COMPLETION, ERROR, INFORMATION, INQUIRY, NESTING_INDENT, UNEXPECTED, WARNING |
Constructor Summary | |
---|---|
SimpleSystemMessage(String pluginId,
int severity,
String msg)
Creates a String based System Message with a severity and plug-in ID, but no global or plug-in specific message ID or detail message. |
|
SimpleSystemMessage(String pluginId,
int severity,
String msg,
String msgDetails)
Creates a String based System Message with a severity and plug-in ID as well as message details, but no global or plug-in specific message ID. |
|
SimpleSystemMessage(String pluginId,
int severity,
String msg,
Throwable e)
Creates a String based System Message with a severity and plug-in ID, as well as an exception to convert into message details, but no global or plug-in specific message ID. |
|
SimpleSystemMessage(String pluginId,
String messageId,
int severity,
String msg)
Creates a String based System Message with severity and ID, but no message details. |
|
SimpleSystemMessage(String pluginId,
String messageId,
int severity,
String msg,
String msgDetails)
Creates a String based System Message with severity, ID and String message details. |
|
SimpleSystemMessage(String pluginId,
String messageId,
int severity,
String msg,
Throwable e)
Creates a String based System Message with severity and ID, and an Exception that will be converted into message details. |
Method Summary | |
---|---|
String |
getFullMessageID()
Use this method to retrieve the full message ID: Component + SubComponent + Number + indicator |
Methods inherited from class org.eclipse.rse.services.clientserver.messages.SystemMessage |
---|
getIndicator, getLevelOneText, getLevelTwoText, getMessageNumber, getNumSubstitutionVariables, getSubValue, getSubVariables, makeSubstitution, makeSubstitution, makeSubstitution, makeSubstitution, makeSubstitution, setIndicator, setPrefixChar, sub, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SimpleSystemMessage(String pluginId, String messageId, int severity, String msg)
SimpleSystemMessage(String, String, int, String, String)
for
a detailed description.
pluginId
- the id of the originating pluginmessageId
- the RSE-global unique ID or plugin-specific local ID of
the messageseverity
- using IStatus severitiesmsg
- the message textpublic SimpleSystemMessage(String pluginId, String messageId, int severity, String msg, String msgDetails)
SystemMessageFile
along with the
org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()
and
org.eclipse.rse.ui.SystemBasePlugin#getMessage()
methods.
Clients can use either globally unique RSE message IDs or plugin-specific
local IDs. RSE-global message IDs are of the form:
RSE<subcomponent><number>, where the subcomponent is a single
character:
ICommonMessageIds
.
When used in a SimpleSystemMessage, these common message IDs must be used
along with the matching message Strings from CommonMessages
, in
order to be consistent to the user. For example:
msg = new SimpleSystemMessage(Activator.PLUGIN_ID, ICommonMessageIds.MSG_COMM_AUTH_FAILED, IStatus.ERROR, CommonMessages.MSG_COMM_AUTH_FAILED, NLS.bind( CommonMessages.MSG_COMM_AUTH_FAILED_DETAILS, getHost().getAliasName()));Plugin-specific local IDs are totally free to be defined by the plugin that creates a specific message, as long as they are not prefixed by "RSE". It is recommended that plugins define unique IDs for various message situations, because this helps problem determination with end users; but it is not a requirement. Local ID's are specific to the plugin ID: relative IDs are qualified by the specified plugin ID, so they live in the plugin ID namespace.
pluginId
- the id of the originating pluginmessageId
- the RSE-global unique ID or plugin-specific local ID of
the messageseverity
- using IStatus severitiesmsg
- the message text to be logged or displayed to the usermsgDetails
- the message details with additional information to be
displayed on request onlypublic SimpleSystemMessage(String pluginId, String messageId, int severity, String msg, Throwable e)
SimpleSystemMessage(String, String, int, String, String)
for
a detailed description.
pluginId
- the id of the originating pluginmessageId
- the RSE-global unique ID or plugin-specific local ID of
the messageseverity
- using IStatus severitiesmsg
- the message texte
- an exception to convert into detailspublic SimpleSystemMessage(String pluginId, int severity, String msg)
SimpleSystemMessage(String, String, int, String, String)
for a
detailed description about messages and ID's.
pluginId
- the id of the originating pluginseverity
- using IStatus severitiesmsg
- the message textpublic SimpleSystemMessage(String pluginId, int severity, String msg, String msgDetails)
SimpleSystemMessage(String, String, int, String, String)
for a
detailed description about messages and ID's.
pluginId
- the id of the originating pluginseverity
- using IStatus severitiesmsg
- the message textmsgDetails
- the message detailspublic SimpleSystemMessage(String pluginId, int severity, String msg, Throwable e)
SimpleSystemMessage(String, String, int, String, String)
for a
detailed description about messages and ID's.
pluginId
- the id of the originating pluginseverity
- using IStatus severitiesmsg
- the message texte
- an exception to convert into detailsMethod Detail |
---|
public String getFullMessageID()
SystemMessage
getFullMessageID
in class SystemMessage
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |