eventweb.io

Class Logger

java.lang.Object

eventweb.io.Logger

public class Logger
extends java.lang.Object

Logs messages to a file and/or the console.

This class allows a single log output to be copied to multiple destinations.

The logger maintains three output destinations:
A log destination,
A console destination,
An Error destination.
Typically, these are: A log file, System.out, and System.err. However, any PrintWriter can be used for any destination. The same PrintWriter can be specified for multiple destinations, or a destination can specified as null. Duplicate messages are not sent to the same destination. (If two separate PrintWriters are created for the same OutputStream they do not appear as the same destination, and duplicate messages may occur.)

In the unconfigured state, the default logger writes all messages to System.out, and error messages are also written to System.err.

Version:

1.4.1 09/09/10

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
static java.lang.String	PNL Platform line separator (newline on UNIX)
static java.lang.String	SEPARATOR_LINE A string of 78 dashes
static java.lang.String	VERSION Class version

Constructor Summary

Constructors

Constructor and Description
Logger(java.io.PrintWriter logWriter, java.io.PrintWriter consoleWriter, java.io.PrintWriter errorWriter) Create a new Logger. This constructor does not affect the default logger.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(java.io.PrintWriter logWriter, java.io.PrintWriter consoleWriter, java.io.PrintWriter errorWriter) Configure the logger.
java.io.PrintWriter	getLogDest() Get Primary log output destination.
static Logger	getLogger() Get a reference to the default Logger.
static Logger	getLogger(java.io.PrintWriter logWriter, java.io.PrintWriter consoleWriter, java.io.PrintWriter errorWriter) Get a reference to the default Logger.
LoggingReader	getLoggingReader(java.io.Reader in, java.lang.String id) Get a LoggingReader that logs to the primary log destination for this logger.
LoggingWriter	getLoggingWriter(java.io.Writer out, java.lang.String id) Get a LoggingWriter that logs to the primary log destination for this logger.
boolean	isDebugging() Get debug status.
boolean	isTracingIo()
void	printConln() Print a blank line to the console output destination.
void	printConln(boolean timestamp) Print to the console output destination with optional timestamp.
void	printConln(java.lang.String message) Print to the console output destination.
void	printConln(java.lang.String message, boolean timestamp) Print to the console output destination with optional timestamp.
void	printErrln() Print a blank line to the error output destination.
void	printErrln(boolean timestamp) Print to the error output destination with optional timestamp.
void	printErrln(java.lang.String message) Print to the error output destination.
void	printErrln(java.lang.String message, boolean timestamp) Print to the error output destination with optional timestamp.
void	println() Print a blank line to the primary log output destination.
void	println(boolean timestamp) Print to the primary log output destination with optional timestamp.
void	println(java.lang.String message) Print to the primary log output destination.
void	println(java.lang.String message, boolean timestamp) Print to the primary log output destination with optional timestamp.
void	setDebugging(boolean debug) Set or clear debug mode.
void	setTracingIo(boolean ioTrace)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

SEPARATOR_LINE

public static final java.lang.String SEPARATOR_LINE

A string of 78 dashes

See Also:

Constant Field Values

PNL

public static final java.lang.String PNL

Platform line separator (newline on UNIX)

Constructor Detail

Logger

public Logger(java.io.PrintWriter logWriter,
      java.io.PrintWriter consoleWriter,
      java.io.PrintWriter errorWriter)

Create a new Logger.
This constructor does not affect the default logger.

Parameters:

logWriter - PrintWriter to log destination

consoleWriter - PrintWriter to console destination

errorWriter - PrintWriter to error destination

Method Detail

getLogger

public static Logger getLogger()

Get a reference to the default Logger.

Returns:

The default Logger

getLogger

public static Logger getLogger(java.io.PrintWriter logWriter,
               java.io.PrintWriter consoleWriter,
               java.io.PrintWriter errorWriter)

Get a reference to the default Logger.

If the default Logger has not been configured, configure it using the passed parameters. If the default Logger has already been configured, ignore the passed parameters.
This is useful in a servlet context, where peer servlets use the same log.

Parameters:

logWriter - PrintWriter to log destination

consoleWriter - PrintWriter to console destination

errorWriter - PrintWriter to error destination

Returns:

The default Logger

configure

public void configure(java.io.PrintWriter logWriter,
             java.io.PrintWriter consoleWriter,
             java.io.PrintWriter errorWriter)

Configure the logger.
If the Logger has already been configured, override the old configuration.

Parameters:

logWriter -

consoleWriter -

errorWriter -

println

public void println()

Print a blank line to the primary log output destination.
(No time-stamp)

println

public void println(java.lang.String message)

Print to the primary log output destination.
(No time-stamp)

Parameters:

message - The message to be printed

println

public void println(boolean timestamp)

Print to the primary log output destination with optional timestamp.

Parameters:

timestamp - If true, print a time-stamp

println

public void println(java.lang.String message,
           boolean timestamp)

Print to the primary log output destination with optional timestamp.

Parameters:

message - The message to be printed

timestamp - If true, time-stamp the message

printConln

public void printConln()

Print a blank line to the console output destination.
(No time-stamp)

printConln

public void printConln(java.lang.String message)

Print to the console output destination.
(No time-stamp)

Parameters:

message - The message to be printed

printConln

public void printConln(boolean timestamp)

Print to the console output destination with optional timestamp.

Parameters:

timestamp - If true, print a time-stamp

printConln

public void printConln(java.lang.String message,
              boolean timestamp)

Print to the console output destination with optional timestamp.

Parameters:

message - The message to be printed

timestamp - If true, time-stamp the message

printErrln

public void printErrln()

Print a blank line to the error output destination.
(No time-stamp)

printErrln

public void printErrln(java.lang.String message)

Print to the error output destination.
(No time-stamp)

Parameters:

message - The message to be printed

printErrln

public void printErrln(boolean timestamp)

Print to the error output destination with optional timestamp.

Parameters:

timestamp - If true, print a time-stamp

printErrln

public void printErrln(java.lang.String message,
              boolean timestamp)

Print to the error output destination with optional timestamp.

Parameters:

message - The message to be printed

timestamp - If true, time-stamp the message

isDebugging

public boolean isDebugging()

Get debug status.

Returns:

true, if debug mode is set.

setDebugging

public void setDebugging(boolean debug)

Set or clear debug mode.

Parameters:

debug - If true, set debug mode

isTracingIo

public boolean isTracingIo()

setTracingIo

public void setTracingIo(boolean ioTrace)

getLogDest

public java.io.PrintWriter getLogDest()

Get Primary log output destination.

Returns:

Primary log output destination

getLoggingReader

public LoggingReader getLoggingReader(java.io.Reader in,
                             java.lang.String id)

Get a LoggingReader that logs to the primary log destination for this logger.

Parameters:

in - The base input reader

id - Id to use for the log entries

Returns:

The LoggingReader

getLoggingWriter

public LoggingWriter getLoggingWriter(java.io.Writer out,
                             java.lang.String id)

Get a LoggingWriter that logs to the primary log destination for this logger.

Parameters:

out - The base output writer

id - Id to use for the log entries

Returns:

The LoggingWriter