org.exolab.castor.util
Class Logger

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          org.exolab.castor.util.Logger

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class Logger
extends java.io.PrintWriter

Simple logging facility. This logger extends PrintWriter which is used to trace SQL statements, Castor operations and mapping resolutions.

This logger augments PrintWriter by adding a prefix to each printed line and optionally a time stamp, enabling easy post-mortem analysis.

Version:

$Revision: 1.2 $ $Date: 2005/03/05 13:41:57 $

Author:

Assaf Arkin

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Logger(java.io.OutputStream output)
Constructs a new logger to use the specified output stream.

Logger(java.io.Writer writer)
Constructs a new logger to use the specified writer.

Method Summary

static java.io.PrintWriter	getSystemLogger() Returns the default logger.
protected void	prefixLine() Called before printing from all of the print methods.
void	print(boolean value)
void	print(char value)
void	print(char[] value)
void	print(double value)
void	print(float value)
void	print(int value)
void	print(long value)
void	print(java.lang.Object value)
void	print(java.lang.String value)
void	println()
void	println(boolean value)
void	println(char value)
void	println(char[] value)
void	println(double value)
void	println(float value)
void	println(int value)
void	println(long value)
void	println(java.lang.Object value)
void	println(java.lang.String value)
Logger	setLogTime(boolean logTime) Determines whether to print the time at the beggining of each log line.
Logger	setPrefix(java.lang.String prefix) Sets the prefix, a short name to print at the beginning of each log line.
static void	setSystemLogger(java.io.PrintWriter system) Sets the default logger.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, printf, printf, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(java.io.OutputStream output)

Constructs a new logger to use the specified output stream.

Logger

public Logger(java.io.Writer writer)

Constructs a new logger to use the specified writer.

Method Detail

getSystemLogger

public static java.io.PrintWriter getSystemLogger()

Returns the default logger. This logger is used to produce system messages.

setSystemLogger

public static void setSystemLogger(java.io.PrintWriter system)

Sets the default logger. This logger is used to produce system messages.

setPrefix

public Logger setPrefix(java.lang.String prefix)

Sets the prefix, a short name to print at the beginning of each log line. If a null is passed, no prefix precedes logged lines.

Parameters:

prefix - The prefix to use for each line

Returns:

This logger

setLogTime

public Logger setLogTime(boolean logTime)

Determines whether to print the time at the beggining of each log line.

Parameters:

logTime - True if time should appear at the beggining of each log line

Returns:

This logger

println

public void println()

Overrides:

println in class java.io.PrintWriter

println

public void println(boolean value)

Overrides:

println in class java.io.PrintWriter

print

public void print(boolean value)

Overrides:

print in class java.io.PrintWriter

println

public void println(char value)

Overrides:

println in class java.io.PrintWriter

print

public void print(char value)

Overrides:

print in class java.io.PrintWriter

println

public void println(int value)

Overrides:

println in class java.io.PrintWriter

print

public void print(int value)

Overrides:

print in class java.io.PrintWriter

println

public void println(long value)

Overrides:

println in class java.io.PrintWriter

print

public void print(long value)

Overrides:

print in class java.io.PrintWriter

println

public void println(float value)

Overrides:

println in class java.io.PrintWriter

print

public void print(float value)

Overrides:

print in class java.io.PrintWriter

println

public void println(double value)

Overrides:

println in class java.io.PrintWriter

print

public void print(double value)

Overrides:

print in class java.io.PrintWriter

println

public void println(char[] value)

Overrides:

println in class java.io.PrintWriter

print

public void print(char[] value)

Overrides:

print in class java.io.PrintWriter

println

public void println(java.lang.String value)

Overrides:

println in class java.io.PrintWriter

print

public void print(java.lang.String value)

Overrides:

print in class java.io.PrintWriter

println

public void println(java.lang.Object value)

Overrides:

println in class java.io.PrintWriter

print

public void print(java.lang.Object value)

Overrides:

print in class java.io.PrintWriter

prefixLine

protected final void prefixLine()

Called before printing from all of the print methods. If at the beginning of a new line, the data/time and prefix will be printed.