|
IBM Rational Functional Tester Version 8.2.1 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.rational.test.ft.services.SimpleLogAdapter com.rational.test.ft.services.LogAdapter com.rational.test.ft.services.LogExtensionAdapter com.rational.test.ft.services.TextLog
public class TextLog
A simple log implementation that writes out the log messages in text format. The messages will be written to either System.out or to a file if one is specified and can be opened. This format of the log messages is not compatible with the log viewer format.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.rational.test.ft.services.LogExtensionAdapter |
---|
LogExtensionAdapter.ImageMetadata |
Field Summary |
---|
Fields inherited from class com.rational.test.ft.services.LogExtensionAdapter |
---|
MAX_IMAGE_DIMENSION |
Fields inherited from class com.rational.test.ft.services.LogAdapter |
---|
spaceDelimeter |
Constructor Summary | |
---|---|
TextLog()
|
|
TextLog(java.lang.String script,
java.lang.String logName)
Default constructor just uses System.out for the PrintStream. |
Method Summary | |
---|---|
void |
closeLog()
This method closes a log file. |
java.lang.String |
getLogFilename()
Returns the name of the log filename including the file extension but no directory. |
void |
initLog()
This method opens a log file with the specified name. |
boolean |
openLogViewer()
The callback function to open the viewer for the log. |
void |
setPrintDateTime(boolean print)
Set whether to print the date/time in the log entry |
boolean |
viewerKnowsHowToBringUpComparator()
This answers yes/no whether the log-viewer associated with this log knows how to bring up our comparator. |
void |
writeLog(ILogMessage message)
Write a message into the log. |
Methods inherited from class com.rational.test.ft.services.LogExtensionAdapter |
---|
applicationStart, applicationStart, callScript, close, configuration, createApplicationStartMessage, createConfigurationMessage, createTestResultMessage, createTimerEndMessage, createTimerStartMessage, createVPMessage, exception, exception, getTimestamp, open, persistImage, scriptEnd, scriptStart, setLogDirectory, setLogName, timerEnd, timerStart, write, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TextLog(java.lang.String script, java.lang.String logName)
script
- The script name (optionally includes package(s))logname
- The subdirectory under logs we will write to
(defaults to scriptname if null is passed)public TextLog()
Method Detail |
---|
public java.lang.String getLogFilename()
getLogFilename
in interface ILog
getLogFilename
in class LogExtensionAdapter
public void initLog() throws LogException
initLog
in class LogExtensionAdapter
LogException
public void closeLog()
closeLog
in class LogExtensionAdapter
public void setPrintDateTime(boolean print)
print
- Whether to print the date/time.public void writeLog(ILogMessage message)
writeLog
in class LogExtensionAdapter
message
- The message (i.e. resultCode, eventCode,
note, and details)public boolean viewerKnowsHowToBringUpComparator()
viewerKnowsHowToBringUpComparator
in interface ILog
viewerKnowsHowToBringUpComparator
in class LogAdapter
public boolean openLogViewer()
openLogViewer
in interface ISimpleLog
openLogViewer
in class SimpleLogAdapter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |