|
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.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 |
|
SystemMessageFile(String messageFileName,
URL msgFileURL,
URL dtdURL)
Constructor to use for lazy loading of a system message file. |
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, URL msgFileURL, URL dtdURL)
SystemMessageFile(String,InputStream,InputStream)
constructor and this one is that the former loads the message file synchronously while
this one loads the message file in a thread. The message file and DTD URLs are passed
in here so that the opening of their input streams can be deferred until the time when
the worker thread is started and able to load the message file.
messageFileName
- the name of the system message filemsgFileURL
- the URL to the message filedtdURL
- the URL to the DTD for the message filepublic 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
- name of the message file
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)
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
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.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |