org.apache.jackrabbit.spi.commons.logging

Class WriterLogWriter

java.lang.Object

org.apache.jackrabbit.spi.commons.logging.WriterLogWriter

All Implemented Interfaces:

LogWriter

public class WriterLogWriter
extends java.lang.Object
implements LogWriter

LogWriter implementation which uses a Writer for persisting log messages.

Constructor Summary

Constructors

Constructor and Description
WriterLogWriter(java.io.Writer log, java.lang.String category) Create a new instance which uses the passed writer logger for persisting the log messages.

Method Summary

Methods

Modifier and Type	Method and Description
void	enter(java.lang.String methodName, java.lang.Object[] args) Logs the call at debug level is debug level is enabled.
void	error(java.lang.String methodName, java.lang.Object[] args, java.lang.Exception e) Logs the exception including a stack trace at debug level is debug level is enabled.
void	leave(java.lang.String methodName, java.lang.Object[] args, java.lang.Object result) Logs the call at debug level is debug level is enabled.
long	systemTime() Returns

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterLogWriter

public WriterLogWriter(java.io.Writer log,
               java.lang.String category)

Create a new instance which uses the passed writer logger for persisting the log messages.

Parameters:

log - writer for output

category - log category

Method Detail

systemTime

public long systemTime()

Returns

   System.currentTimeMillis();
 

Implementation specific time stamp which is logged along with each log message. The values returned by this method should be monotone with respect to the time they represent.

Specified by:

systemTime in interface LogWriter

Returns:

enter

public void enter(java.lang.String methodName,
         java.lang.Object[] args)

Logs the call at debug level is debug level is enabled. Called right before a method of a SPI entity is called.

Specified by:

enter in interface LogWriter

Parameters:

methodName - name of the method which a about to be called

args - arguments passed to the methods which is about to be called.

leave

public void leave(java.lang.String methodName,
         java.lang.Object[] args,
         java.lang.Object result)

Logs the call at debug level is debug level is enabled. Called right after a method of a SPI entity has been called if no exception was thrown.

Specified by:

leave in interface LogWriter

Parameters:

methodName - name of the method which has been called

args - arguments passed to the method which has been called

result - return value of the method which has been called

error

public void error(java.lang.String methodName,
         java.lang.Object[] args,
         java.lang.Exception e)

Logs the exception including a stack trace at debug level is debug level is enabled. Called right after a method of a SPI entity has been called and an exception was thrown.

Specified by:

error in interface LogWriter

Parameters:

methodName - name of the method which has been called

args - arguments passed to the method which has been called

e - exception which was thrown by the method which has been called