irssibot.util.log
Interface CommonLog

All Known Implementing Classes:

FileLog, NullLog, StdoutLog

public interface CommonLog

Common log interface for logging system.

Version:

$Name: $ $Revision: 1.2 $

Author:

Matti Dahlbom

Field Summary

static java.lang.String

PROPERTY_FILE_PATH_PROPERTY_NAME Property name for property file path.

Method Summary

java.lang.String	getPropertyFilePath() Returns path for property file from which this CommonLog was initialized.
void	init(java.util.Properties properties) Initializes this logger.
void	logMessage(java.lang.String message) Writes a log message to log.
void	stop() Stops and deinits this logger.

Field Detail

PROPERTY_FILE_PATH_PROPERTY_NAME

public static final java.lang.String PROPERTY_FILE_PATH_PROPERTY_NAME

Property name for property file path.

See Also:

Constant Field Values

Method Detail

logMessage

public void logMessage(java.lang.String message)
                throws LogException

Writes a log message to log.

Parameters:

message - preformatted log message to be written as it is

Throws:

LogException - if logging error occurs

init

public void init(java.util.Properties properties)

Initializes this logger.

Parameters:

properties - init properties, or null if none supplied

stop

public void stop()

Stops and deinits this logger.

getPropertyFilePath

public java.lang.String getPropertyFilePath()

Returns path for property file from which this CommonLog was initialized.

Returns:

path to property file