DTDDoc

Class Logger

java.lang.Object

DTDDoc.Logger

Direct Known Subclasses:

AntLogger, SystemLogger

public abstract class Logger
extends Object

A logger class that should be compatible with Ant and Maven's log. This class was introduced to abstract the details of Ant and Maven's logging. This is needed because when DTDDoc works as an Ant task we use Ant for logs but when we're under Maven we use Maven's log.

Author:

Stefan Champailler schampailler_at_skynet_dot_be

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	error(String msg) Logs an error message.
void	error(String msg, Exception ex) Logs an error message and an associated exception (stack trace).
abstract void	info(String msg) Logs an informational message.
abstract void	warn(String msg) Logs a warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger()

Method Detail

info

public abstract void info(String msg)

Logs an informational message. Such a message never indicates a problem to the user.

Parameters:

msg - Message to log.

warn

public abstract void warn(String msg)

Logs a warning message. Such a message indicates a problem to the user. The problem doesn't affect the course of DTDDoc but is worth noting because it's the result of a an action or the data of the user.

Parameters:

msg - Message to log.

error

public abstract void error(String msg)

Logs an error message. Such a message indicates something wrong happened inside DTDDoc. This thing may affect the course of execution of DTDDoc. That is, if it happens, the result of the execution is not guaranteed.

Parameters:

msg - Message to log.

error

public void error(String msg,
         Exception ex)

Logs an error message and an associated exception (stack trace).

Parameters:

msg - Message to log.

ex - Exception to log.

See Also:

error( String msg)