com.rational.test.ft.services

Class NullLog

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.NullLog

All Implemented Interfaces:

ILog, ISimpleLog

public class NullLog
extends LogExtensionAdapter

NullLog: An implementation of the ILog interface that writes no log, for when the rt.write_log option is set to false.

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

ASTERISK, DOT, spaceDelimeter

Fields inherited from interface com.rational.test.ft.services.ILog

KEY_POST_EXECUTION_END_MESSAGE, KEY_PRE_EXECUTION_START_MESSAGE, MASKED_PROP_GUI_ACTION_METHOD_ARGS, MASKED_PROP_GUI_ACTION_METHOD_NAME, PROP_ACTUAL, PROP_ADDITIONAL_INFO, PROP_APP_TYPE, PROP_APPLICATION, PROP_APPTYPE, PROP_ARGUMENTS, PROP_ASSIGNEDVARIABLE_NAME, PROP_BASELINE, PROP_BUFFERED_SNAPSHOT, PROP_DATAPOOL_STORE, PROP_DEFAULT_SCRIPT_DATAPOOL_NAME, PROP_ELAPSED_TIME, PROP_EXCEPTION_CONTEXT, PROP_EXCEPTION_MESSAGE, PROP_EXCEPTION_NAME, PROP_EXCEPTION_STACK, PROP_EXECUTABLE, PROP_EXPECTED, PROP_FAILURE_DESCRIPTION, PROP_ITERATION_COUNT, PROP_LINENUMBER, PROP_NAME, PROP_PROPERTY_NAME, PROP_PROPERTY_VALUE, PROP_SCREEN_SNAPSHOT, PROP_SCRIPT_ID, PROP_SCRIPT_NAME, PROP_SIMPLIFIEDSCRIPT_GRPNAME, PROP_SIMPLIFIEDSCRIPT_LINE, PROP_SIMPLIFIEDSCRIPT_LINENUMBER, PROP_TESTCASE_DESCRIPTION, PROP_TESTCASE_NAME, PROP_USER_SCREEN_SNAPSHOT, PROP_VP_TYPE, PROP_WORKINGDIRECTORY, SCREEN_SNAPSHOT_FILE_BASE, SCREEN_SNAPSHOT_FILE_EXT, SCREEN_SNAPSHOT_FILE_NAME, USER_SCREEN_SNAPSHOT_FILE_BASE, VP_DIFF_TYPE, VP_IMAGE_ACT, VP_IMAGE_EXP, VP_JSON_FILE_PATH, VP_TYPE_ALPHA_NUM, VP_TYPE_CLIPBOARD, VP_TYPE_FILE_COMPARE, VP_TYPE_FILE_EXIST, VP_TYPE_FULL_IMAGE, VP_TYPE_MENU, VP_TYPE_MODULE_EXIST, VP_TYPE_OBJECT_DATA, VP_TYPE_OBJECT_PROP, VP_TYPE_OCR_IMAGE, VP_TYPE_REGION_IMAGE, VP_TYPE_WEBSITE_COMPARE, VP_TYPE_WEBSITE_SCAN, VP_TYPE_WINDOW_EXIST, VP_TYPE_WINDOW_IMAGE

Fields inherited from interface com.rational.test.ft.services.ISimpleLog

DISABLE_LOGGING, EVENT_APPLICATION_END, EVENT_APPLICATION_START, EVENT_APPLICATON_ACTION, EVENT_CALL_SCRIPT, EVENT_CONFIGURATION, EVENT_CUSTOM, EVENT_EXPORT, EVENT_GENERAL, EVENT_SCRIPT_END, EVENT_SCRIPT_START, EVENT_TIMER_END, EVENT_TIMER_START, EVENT_VP, LOG_DISABLE_GUI_ACTION, LOG_DISABLE_GUI_SNAPSHOT_ACTION, LOG_ENABLE_GUI_ACTION, LOG_ENABLE_GUI_SNAPSHOT_ACTION, LOG_FAILURE, LOG_FAILURES, LOG_FAILURES_WARNINGS, LOG_FAILURES_WARNINGS_PASS, LOG_FAILURES_WARNINGS_PASS_INFO, LOG_INFORMATION, LOG_PASS, LOG_WARNING

Constructor Summary

Constructors

Constructor and Description
NullLog()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeLog() This method closes a log file.
void	initLog() This method opens a log file.
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, getLocationForImagePersistance, getLogFilename, getTimestamp, isVisualStudioPlayback, open, persistImage, scriptEnd, scriptStart, setLogDirectory, setLogName, timerEnd, timerStart, write, write

Methods inherited from class com.rational.test.ft.services.LogAdapter

appendLogProperties, applicationStart, applicationStart, createApplicationStartMessage, createAssignActionMessage, createGUIActionMessage, createGUIActionMessage, createLogParticipantMessage, createMessage, createMessage, createTimerEndMessage, ensureLogDirectory, getCurrentDatapool, getCurrentLogFilter, getCurrentScriptResult, getExportLogDirectory, getExportReportParam, getLastScriptResult, getLogDirectory, getLogName, getLogType, getNextUserSnapshotName, getNextUserSnapshotNumber, getScreenShotFile, getScriptName, getScriptPlaybackParams, getSimplifiedScriptElement, getSSGroupForLine, getSummaryEvent, getTestResult, getTimerAndEnd, getTimerValue, info, isLoggingEnabled, isLogGuiActionEnabled, isLogScreenSnapshotActionEnabled, logRootException, processPostGuiAction, processPreGuiAction, setCurrentLogFilter, setExportLogDirectory, setExportReportParam, setLogGUIAction, setLogScreenSnapshotAction, setLogType, setScriptPlaybackParams, setTopResult, shouldBringUpLog, timerEnd, writeGUIAction

Methods inherited from class com.rational.test.ft.services.SimpleLogAdapter

openLogViewer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.rational.test.ft.services.ISimpleLog

openLogViewer

Constructor Detail

NullLog

public NullLog()

Method Detail

initLog

public void initLog()
             throws LogException

This method opens a log file. No-op in the case of NullLog.

Specified by:

initLog in class LogExtensionAdapter

Throws:

LogException

Parameters:

fileName - The name of the log file.

closeLog

public void closeLog()

This method closes a log file. No-op in the case of NullLog.

Specified by:

closeLog in class LogExtensionAdapter

writeLog

public void writeLog(ILogMessage message)

Write a message into the log. This interface allows a message with a detailed description to be set in the log file (i.e. name/value pairs).

Specified by:

writeLog in class LogExtensionAdapter

Parameters:

message - The message (i.e. resultCode, eventCode, note, and details)

viewerKnowsHowToBringUpComparator

public boolean viewerKnowsHowToBringUpComparator()

This answers yes/no whether the log-viewer associated with this log knows how to bring up our comparator. The answer is true for TSS log, and false otherwise. This is used to decide whether to do our own bring-up-comparator after playback.

Specified by:

viewerKnowsHowToBringUpComparator in interface ILog

Overrides:

viewerKnowsHowToBringUpComparator in class LogAdapter