|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.rse.services.clientserver.messages.SystemMessageFile
public class SystemMessageFile
Use this class to open, and parse, a RSE-style message file.
Constructor Summary | |
---|---|
SystemMessageFile(String messageFileName,
InputStream messageFile,
InputStream dtdStream)
Constructor |
Method Summary | |
---|---|
void |
error(SAXParseException ex)
XML Parser-required method: XML-parser Error. |
void |
fatalError(SAXParseException ex)
XML Parser-required method: XML-parser Fatal error. |
protected org.eclipse.rse.services.clientserver.messages.SystemMessageFile.MessageFileInfo |
getFromCache(String messageFileName)
If the named message file has already been loaded return its MessageFileInfo |
SystemMessage |
getMessage(String msgId)
Use this method to retrieve a message from the message file. |
protected SystemMessage |
loadSystemMessage(String componentAbbr,
String subComponentAbbr,
String msgNumber,
char msgIndicator,
String msgL1,
String msgL2)
Override this to provide different extended SystemMessage implementation |
boolean |
printHTML(String fullFileName)
Use this method to generate html documentation for the messages in the message file. |
boolean |
scanForDuplicates()
Use this method to scan message file for duplicate messages. |
void |
warning(SAXParseException ex)
XML Parser-required method: XML-parser warning. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SystemMessageFile(String messageFileName, InputStream messageFile, InputStream dtdStream)
messageFileName
- - a key used to determine if a message file has already been loaded.
Usually the name of the xml file containing the message file.messageFile
- the stream containing the message file.dtdStream
- the stream containing the dtd for this message file.Method Detail |
---|
protected org.eclipse.rse.services.clientserver.messages.SystemMessageFile.MessageFileInfo getFromCache(String messageFileName)
messageFileName
-
public SystemMessage getMessage(String msgId)
msgId
- - the ID of the message to retrieve. This is the concatenation of the
message's component abbreviation, subcomponent abbreviation, and message ID as declared
in the message xml file.
protected SystemMessage loadSystemMessage(String componentAbbr, String subComponentAbbr, String msgNumber, char msgIndicator, String msgL1, String msgL2) throws IndicatorException
componentAbbr
- a three letter component namesubComponentAbbr
- a one letter subcomponent namemsgNumber
- a four digit message numbermsgIndicator
- a single character message type indicatormsgL1
- the first level text that describes the errormsgL2
- the second level text that provides details about the error and possible recovery
IndicatorException
- if the message type indicator is invalid.for message type indicator constants
public boolean scanForDuplicates()
public boolean printHTML(String fullFileName)
fullFileName
- - the fully qualified name of the file to write to. Overwrites current contents.
public void warning(SAXParseException ex)
warning
in interface ErrorHandler
public void error(SAXParseException ex)
error
in interface ErrorHandler
public void fatalError(SAXParseException ex) throws SAXException
fatalError
in interface ErrorHandler
SAXException
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |