org.zoolu.util

Class LogWriter

java.lang.Object

org.zoolu.util.LogWriter

All Implemented Interfaces:

Logger

Direct Known Subclasses:

LogRotationWriter

public class LogWriter
extends java.lang.Object
implements Logger

Simple logger that writes log messages onto a logfile, or standard output, or Writer, or OutputStream or PrintStream.

When creating a logger you can also specify a priority_level and a maximum_size for the log.

The attribute priority_level is used to manage different levels of verboseness. When adding a log message through the methods Logger.log(LogLevel,String) or Logger.log(LogLevel,Class,String) a LogLevel log_level for the given message is specified; only log messages with a log_level greater or equal to the logger priority_level are recorded.
With priority level LogLevel.OFF no messages are logged. With priority level LogLevel.ALL all messages are logged.

The attribute maximum_size is used to limit the size the log. When the log size reaches the maximum_size value, no more log messages are recorded.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MAX_SIZE Default maximum log file size (1MB)
protected java.io.Writer	out The log writer

Constructor Summary

Constructors

Constructor and Description
LogWriter(java.io.OutputStream out) Creates a new LogWriter.
LogWriter(java.io.OutputStream out, LogLevel logging_level) Creates a new LogWriter.
LogWriter(java.lang.String file_name) Creates a new the LogWriter.
LogWriter(java.lang.String file_name, LogLevel logging_level) Creates a new the LogWriter.
LogWriter(java.lang.String file_name, LogLevel logging_level, long max_size) Creates a new the LogWriter.
LogWriter(java.lang.String file_name, LogLevel logging_level, long max_size, boolean append) Creates a new the LogWriter.
LogWriter(java.io.Writer out) Creates a new LogWriter.
LogWriter(java.io.Writer out, LogLevel logging_level) Creates a new LogWriter.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the log writer.
LogLevel	getLoggingLevel() Gets the current logging level.
void	log(LogLevel level, java.lang.Class source_class, java.lang.String message) Adds a log message.
void	log(LogLevel level, java.lang.String message) Adds a log message.
void	log(java.lang.String message) Adds a log message.
protected void	reset() Resets the char counter.
void	setLoggingLevel(LogLevel logging_level) Sets the logging level.
void	setTimestamp(boolean timestamp) Enables or disables writing a timestamp header.
protected void	write(java.lang.String str) Writes a string onto the inner writer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIZE

public static long DEFAULT_MAX_SIZE

Default maximum log file size (1MB)

out

protected java.io.Writer out

The log writer

Constructor Detail

LogWriter

public LogWriter(java.io.Writer out)

Creates a new LogWriter.

Parameters:

out - the Writer where log messages are written to

LogWriter

public LogWriter(java.io.Writer out,
                 LogLevel logging_level)

Creates a new LogWriter.

Parameters:

out - the Writer where log messages are written to

logging_level - the logging level

LogWriter

public LogWriter(java.io.OutputStream out)

Creates a new LogWriter.

Parameters:

out - the OutputStream where log messages are written to

LogWriter

public LogWriter(java.io.OutputStream out,
                 LogLevel logging_level)

Creates a new LogWriter.

Parameters:

out - the OutputStream where log messages are written to

logging_level - the logging level

LogWriter

public LogWriter(java.lang.String file_name)

Creates a new the LogWriter.

Parameters:

file_name - the file where log messages are written to

LogWriter

public LogWriter(java.lang.String file_name,
                 LogLevel logging_level)

Creates a new the LogWriter.

Parameters:

file_name - the file where log messages are written to

logging_level - the logging level

LogWriter

public LogWriter(java.lang.String file_name,
                 LogLevel logging_level,
                 long max_size)

Creates a new the LogWriter.

Parameters:

file_name - the file where log messages are written to

logging_level - the logging level

max_size - the maximum size for the log file, that is the maximum number of characters that can be wirtten

LogWriter

public LogWriter(java.lang.String file_name,
                 LogLevel logging_level,
                 long max_size,
                 boolean append)

Creates a new the LogWriter.

Parameters:

file_name - the file where log messages are written to

logging_level - the logging level

max_size - the maximum size for the log file, that is the maximum number of characters that can be wirtten

append - if true, the file is opened in 'append' mode, that is the new messages are appended to the previously saved file (the file is not rewritten)

Method Detail

setLoggingLevel

public void setLoggingLevel(LogLevel logging_level)

Sets the logging level.

Parameters:

logging_level - the logging level

getLoggingLevel

public LogLevel getLoggingLevel()

Gets the current logging level.

Returns:

the logging level

setTimestamp

public void setTimestamp(boolean timestamp)

Enables or disables writing a timestamp header.

Parameters:

timestamp - true for enabling the use of timestamps

close

public void close()

Closes the log writer.

log

public void log(java.lang.String message)

Adds a log message.

Specified by:

log in interface Logger

Parameters:

message - the message to be logged

log

public void log(LogLevel level,
                java.lang.String message)

Adds a log message.

Specified by:

log in interface Logger

Parameters:

level - the log level of this message; only messages with log level greater than or equal to the logging_level of the log writer are actually recorded

message - the message to be logged

log

public void log(LogLevel level,
                java.lang.Class source_class,
                java.lang.String message)

Adds a log message.

Specified by:

log in interface Logger

Parameters:

level - the log level of this message; only messages with log level greater than or equal to the logging_level of the log writer are actually recorded

source_class - the origin of this log message

message - the message to be logged

write

protected void write(java.lang.String str)

Writes a string onto the inner writer.

Parameters:

str - the string to be written

reset

protected void reset()

Resets the char counter.