org.safs.tools.logs

Interface LogsInterface

All Known Implementing Classes:

SAFSLOGS

public interface LogsInterface

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_STATUSINFO_ID "NOT PROVIDED", Default StatusInfo ID for logStatusInfo.

Method Summary

Modifier and Type	Method and Description
void	closeAllLogs() Close ALL logs.
void	closeLog(UniqueIDInterface log) Close the specified log.
void	initLog(UniqueLogInterface logInfo) Initialize/Open the specified log.
void	logMessage(UniqueMessageInterface message) Log a message to a particular log.
void	logStatusInfo(UniqueIDInterface log, StatusInterface status, java.lang.String infoID) Log a Status Report to a particular log.
void	resumeAllLogs() Resume loggint to ALL previosly suspended logs.
void	resumeLog(UniqueIDInterface log) Resume logging to a previously suspended log.
void	setLogLevel(UniqueLogLevelInterface loglevel) Set/Change the log level or filter for log messages.
void	suspendAllLogs() Suspend logging to ALL open logs.
void	suspendLog(UniqueIDInterface log) Suspend logging for a particular log.
void	truncate(boolean enabled) Enable/Disable the truncation of logged messages.
void	truncate(int numchars) Enable truncation of logged messages to the numchars length provided.

Field Detail

DEFAULT_STATUSINFO_ID

static final java.lang.String DEFAULT_STATUSINFO_ID

"NOT PROVIDED", Default StatusInfo ID for logStatusInfo.

See Also:

Constant Field Values

Method Detail

initLog

void initLog(UniqueLogInterface logInfo)

Initialize/Open the specified log.

setLogLevel

void setLogLevel(UniqueLogLevelInterface loglevel)

Set/Change the log level or filter for log messages. This will likely be implementation specific.

logMessage

void logMessage(UniqueMessageInterface message)

Log a message to a particular log.

logStatusInfo

void logStatusInfo(UniqueIDInterface log,
                   StatusInterface status,
                   java.lang.String infoID)

Log a Status Report to a particular log.

Parameters:

log - -- the facname of the log to generate the report.

status - -- the StatusInterface containing the counts to report.

infoID - -- Name or ID to give to the status information in the log. This is usually used to show the subject of the status info. For example, "Regression Test", "TestCase 123456", etc.. DEFAULT_STATUSINFO_ID used if null or zero-length.

suspendLog

void suspendLog(UniqueIDInterface log)

Suspend logging for a particular log.

suspendAllLogs

void suspendAllLogs()

Suspend logging to ALL open logs.

resumeLog

void resumeLog(UniqueIDInterface log)

Resume logging to a previously suspended log.

resumeAllLogs

void resumeAllLogs()

Resume loggint to ALL previosly suspended logs.

truncate

void truncate(int numchars)

Enable truncation of logged messages to the numchars length provided.

truncate

void truncate(boolean enabled)

Enable/Disable the truncation of logged messages.

closeLog

void closeLog(UniqueIDInterface log)

Close the specified log. Perform any log post-close activities and then release resources .

closeAllLogs

void closeAllLogs()

Close ALL logs. Perform any log post-close activities and then release resources .