com.screenscraper.common

Class FileNotifiable

java.lang.Object

com.screenscraper.common.FileNotifiable

All Implemented Interfaces:

Notifiable

Direct Known Subclasses:

FileHTTPSessionNotifiable, FileScrapingSessionNotifiable

public class FileNotifiable
extends java.lang.Object
implements Notifiable

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Fields inherited from interface com.screenscraper.common.Notifiable

LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO, LEVEL_WARN, STR_LEVEL_DEBUG, STR_LEVEL_ERROR, STR_LEVEL_INFO, STR_LEVEL_WARN

Constructor Summary

Constructors

Constructor and Description
FileNotifiable(java.lang.String fileName, java.lang.String characterSet) Constructs a DefaultScrapingSessionNotifiable to be used with the named file.

Method Summary

Modifier and Type	Method and Description
void	closeLog() Closes the log file.
java.lang.String	getLogFileName() Gets the name of the log file being written to.
int	getLoggingLevel() Gets the current logging level.
void	log(java.lang.String message) Logs a DEBUG message to the log.
void	logDebug(java.lang.String message) Logs a message with LEVEL_DEBUG.
void	logError(java.lang.String message) Logs a message with LEVEL_ERROR.
void	logInfo(java.lang.String message) Logs a message with LEVEL_INFO.
void	logWarn(java.lang.String message) Logs a message with LEVEL_WARN.
void	setLogFile(java.io.File logFile) Sets the log file being written to.
void	setLoggingLevel(int loggingLevel) Sets the current logging level.
void	writeLogLine(java.lang.String message) Logs a message.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

FileNotifiable

public FileNotifiable(java.lang.String fileName,
                      java.lang.String characterSet)

Constructs a DefaultScrapingSessionNotifiable to be used with the named file.

Parameters:

fileName - The name of the File.

characterSet - The character set to use for the log file.

Method Detail

writeLogLine

public void writeLogLine(java.lang.String message)

Logs a message.

Parameters:

message - The message to be logged.

closeLog

public void closeLog()

Closes the log file.

setLogFile

public void setLogFile(java.io.File logFile)

Sets the log file being written to.

Parameters:

logFile - The log file.

getLogFileName

@Nullable
public java.lang.String getLogFileName()

Gets the name of the log file being written to.

Returns:

The name of the log file.

getLoggingLevel

public int getLoggingLevel()

Gets the current logging level.

Specified by:

getLoggingLevel in interface Notifiable

Returns:

The logging level, as defined by one of the "LOGGING" constants.

setLoggingLevel

public void setLoggingLevel(int loggingLevel)

Sets the current logging level.

Specified by:

setLoggingLevel in interface Notifiable

Parameters:

loggingLevel - The logging level, as defined by one of the "LOGGING" constants.

log

public void log(java.lang.String message)

Logs a DEBUG message to the log.

Specified by:

log in interface Notifiable

Parameters:

message - The message to log.

logDebug

public void logDebug(java.lang.String message)

Logs a message with LEVEL_DEBUG.

Specified by:

logDebug in interface Notifiable

Parameters:

message - The message to be logged.

logInfo

public void logInfo(java.lang.String message)

Logs a message with LEVEL_INFO.

Specified by:

logInfo in interface Notifiable

Parameters:

message - The message to be logged.

logWarn

public void logWarn(java.lang.String message)

Logs a message with LEVEL_WARN.

Specified by:

logWarn in interface Notifiable

Parameters:

message - The message to be logged.

logError

public void logError(java.lang.String message)

Logs a message with LEVEL_ERROR.

Specified by:

logError in interface Notifiable

Parameters:

message - The message to be logged.