Package org.cdlib.mrt.utility

Interface LoggerInf

All Known Implementing Classes:

LoggerAbs, TFileLogger

public interface LoggerInf

Defines behavior of classes that store informaational and error messages.

Author:

dloy

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LoggerInf.LogLevel	Enumeration of logging levels and corresponding verbosity level

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the log
void	flush()	Flush the log
int	getErrorMaxLevel()	get threshold for error message creation
int	getMessageMaxLevel()	get threshold for message creation
boolean	isErrorLoggable(LoggerInf.LogLevel logLevel)	is this logLevel high enough to be error logged
boolean	isMessageLoggable(LoggerInf.LogLevel logLevel)	is this logLevel high enough to be message logged
void	logError(String message, int significance)	Log an error message
void	logError(String message, LoggerInf.LogLevel significance)	Log an error message
void	logMessage(String message, int significance)	Log an informational message
void	logMessage(String message, int significance, boolean flushLog)	Log an informational message
void	logMessage(String message, LoggerInf.LogLevel significance)	Log an informational message
void	logMessage(String message, LoggerInf.LogLevel significance, boolean flushLog)	Log an informational message

Method Details

logMessage

void logMessage(String message,
 int significance,
 boolean flushLog)

Log an informational message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance (0 - 10) of the message

flushLog - - flush log at completion of this log output

logMessage

void logMessage(String message,
 int significance)

Log an informational message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance (0 - 10) of the message

logError

void logError(String message,
 int significance)

Log an error message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance (0 - 10) of the message

logMessage

void logMessage(String message,
 LoggerInf.LogLevel significance,
 boolean flushLog)

Log an informational message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance of the message

flushLog - - flush log at completion of this log output

logError

void logError(String message,
 LoggerInf.LogLevel significance)

Log an error message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance of the message

logMessage

void logMessage(String message,
 LoggerInf.LogLevel significance)

Log an informational message

Parameters:

message - - Text of message to be logged

significance - - Level of signifiance (0 - 10) of the message

flush

void flush()

Flush the log

close

void close()

Closes the log

getMessageMaxLevel

int getMessageMaxLevel()

get threshold for message creation

Returns:

message creation threshold (e.g. <=)

isMessageLoggable

boolean isMessageLoggable(LoggerInf.LogLevel logLevel)

is this logLevel high enough to be message logged

Parameters:

logLevel - logging level

Returns:

true=level will be logged

isErrorLoggable

boolean isErrorLoggable(LoggerInf.LogLevel logLevel)

is this logLevel high enough to be error logged

Parameters:

logLevel - logging level

Returns:

true=level will be logged

getErrorMaxLevel

int getErrorMaxLevel()

get threshold for error message creation

Returns:

error message creation threshold (e.g. <=)