RSE
Release 3.2

org.eclipse.rse.ui.messages
Class SystemUIMessageFile

java.lang.Object
  extended by org.eclipse.rse.services.clientserver.messages.SystemMessageFile
      extended by org.eclipse.rse.ui.messages.SystemUIMessageFile
All Implemented Interfaces:
ErrorHandler

public class SystemUIMessageFile
extends SystemMessageFile

A SystemUIMessageFile extends SystemMessageFile and makes it more compatible with Eclipse


Method Summary
static SystemUIMessageFile getMessageFile(String messageFileName, InputStream messageFileStream)
          Factory method for constructing a SystemUIMessageFile that loads the message file synchronously.
static SystemUIMessageFile getMessageFile(String messageFileName, URL messageFileURL)
          Factory method for constructing a SystemUIMessageFile that loads the message file in a thread.
protected  SystemMessage loadSystemMessage(String componentAbbr, String subComponentAbbr, String msgNumber, char msgIndicator, String msgL1, String msgL2)
          Override this to provide different extended SystemMessage implementation
 
Methods inherited from class org.eclipse.rse.services.clientserver.messages.SystemMessageFile
error, fatalError, getFromCache, getMessage, printHTML, scanForDuplicates, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getMessageFile

public static SystemUIMessageFile getMessageFile(String messageFileName,
                                                 InputStream messageFileStream)
Factory method for constructing a SystemUIMessageFile that loads the message file synchronously. If an error occurs when reading the message file DTD then that is logged.

Parameters:
messageFileName - The "registered" name of the message file. Used to determine if the message file has been loaded.
messageFileStream - The stream containing the message file. It is the caller's responsibility to close this stream.
Returns:
The message file that was constructed.

getMessageFile

public static SystemUIMessageFile getMessageFile(String messageFileName,
                                                 URL messageFileURL)
Factory method for constructing a SystemUIMessageFile that loads the message file in a thread. The difference between getMessageFile(String,InputStream) and this method is that the former calls the constructor that loads the message file synchronously while this one loads the message file in a worker thread. The message file URL is passed in here so that the opening of it's input stream can be deferred until the time when the worker thread is started and able to load the message file.

Parameters:
messageFileName - The name of the message file to load.
messageFileURL - The URL to the message file.
Returns:
The message file that was constructed.
Since:
3.1

loadSystemMessage

protected SystemMessage loadSystemMessage(String componentAbbr,
                                          String subComponentAbbr,
                                          String msgNumber,
                                          char msgIndicator,
                                          String msgL1,
                                          String msgL2)
                                   throws IndicatorException
Override this to provide different extended SystemMessage implementation

Overrides:
loadSystemMessage in class SystemMessageFile
Parameters:
componentAbbr -
subComponentAbbr -
msgNumber -
msgIndicator -
msgL1 -
msgL2 -
Returns:
The SystemMessage for the given message information
Throws:
IndicatorException
See Also:
for message type indicator constants

RSE
Release 3.2

Copyright (c) IBM Corporation and others 2000, 2010. All Rights Reserved.