org.apache.maven.doxia.logging
Interface Log

All Known Implementing Classes:

PlexusLoggerWrapper, SystemStreamLog

public interface Log

This interface supplies the API for providing feedback to the user from a Parser or Sink, using standard Doxia channels.
There should be no big surprises here, although you may notice that the methods accept java.lang.CharSequence rather than java.lang.String. This is provided mainly as a convenience, to enable developers to pass things like java.lang.StringBuffer directly into the logger, rather than formatting first by calling toString().
Based on org.apache.maven.plugin.logging.Log.

Since:

1.1

Version:

$Id: Log.java 785531 2009-06-17 09:47:59Z ltheussl $

Author:

jdcasey, ltheussl

Field Summary

static int	LEVEL_DEBUG Typecode for debugging messages.
static int	LEVEL_DISABLED Typecode for disabled log levels.
static int	LEVEL_ERROR Typecode for error messages.
static int	LEVEL_FATAL Typecode for fatal error messages.
static int	LEVEL_INFO Typecode for informational messages.
static int	LEVEL_WARN Typecode for warning messages.

Method Summary

void	debug(CharSequence content) Send a message to the user in the debug error level.
void	debug(CharSequence content, Throwable error) Send a message (and accompanying exception) to the user in the debug error level.
void	debug(Throwable error) Send an exception to the user in the debug error level.
void	error(CharSequence content) Send a message to the user in the error error level.
void	error(CharSequence content, Throwable error) Send a message (and accompanying exception) to the user in the error error level.
void	error(Throwable error) Send an exception to the user in the error error level.
void	info(CharSequence content) Send a message to the user in the info error level.
void	info(CharSequence content, Throwable error) Send a message (and accompanying exception) to the user in the info error level.
void	info(Throwable error) Send an exception to the user in the info error level.
boolean	isDebugEnabled() isDebugEnabled.
boolean	isErrorEnabled() isErrorEnabled.
boolean	isInfoEnabled() isInfoEnabled.
boolean	isWarnEnabled() isWarnEnabled.
void	setLogLevel(int level) Set the current log level.
void	warn(CharSequence content) Send a message to the user in the warn error level.
void	warn(CharSequence content, Throwable error) Send a message (and accompanying exception) to the user in the warn error level.
void	warn(Throwable error) Send an exception to the user in the warn error level.

Field Detail

LEVEL_DEBUG

static final int LEVEL_DEBUG

Typecode for debugging messages.

See Also:

Constant Field Values

LEVEL_INFO

static final int LEVEL_INFO

Typecode for informational messages.

See Also:

Constant Field Values

LEVEL_WARN

static final int LEVEL_WARN

Typecode for warning messages.

See Also:

Constant Field Values

LEVEL_ERROR

static final int LEVEL_ERROR

Typecode for error messages.

See Also:

Constant Field Values

LEVEL_FATAL

static final int LEVEL_FATAL

Typecode for fatal error messages.

See Also:

Constant Field Values

LEVEL_DISABLED

static final int LEVEL_DISABLED

Typecode for disabled log levels.

See Also:

Constant Field Values

Method Detail

setLogLevel

void setLogLevel(int level)

Set the current log level.

Parameters:

level - the log level to set.

isDebugEnabled

boolean isDebugEnabled()

isDebugEnabled.

Returns:

true if the debug error level is enabled.

debug

void debug(CharSequence content)

Send a message to the user in the debug error level.

Parameters:

content - the message to log.

debug

void debug(CharSequence content,
           Throwable error)

Send a message (and accompanying exception) to the user in the debug error level.
The error's stacktrace will be output when this error level is enabled.

Parameters:

content - the message to log.

error - the error to log.

debug

void debug(Throwable error)

Send an exception to the user in the debug error level.
The stack trace for this exception will be output when this error level is enabled.

Parameters:

error - the error to log.

isInfoEnabled

boolean isInfoEnabled()

isInfoEnabled.

Returns:

true if the info error level is enabled.

info

void info(CharSequence content)

Send a message to the user in the info error level.

Parameters:

content - the message to log.

info

void info(CharSequence content,
          Throwable error)

Send a message (and accompanying exception) to the user in the info error level.
The error's stacktrace will be output when this error level is enabled.

Parameters:

content - the message to log.

error - the error to log.

info

void info(Throwable error)

Send an exception to the user in the info error level.
The stack trace for this exception will be output when this error level is enabled.

Parameters:

error - the error to log.

isWarnEnabled

boolean isWarnEnabled()

isWarnEnabled.

Returns:

true if the warn error level is enabled.

warn

void warn(CharSequence content)

Send a message to the user in the warn error level.

Parameters:

content - the message to log.

warn

void warn(CharSequence content,
          Throwable error)

Send a message (and accompanying exception) to the user in the warn error level.
The error's stacktrace will be output when this error level is enabled.

Parameters:

content - the message to log.

error - the error to log.

warn

void warn(Throwable error)

Send an exception to the user in the warn error level.
The stack trace for this exception will be output when this error level is enabled.

Parameters:

error - the error to log.

isErrorEnabled

boolean isErrorEnabled()

isErrorEnabled.

Returns:

true if the error error level is enabled.

error

void error(CharSequence content)

Send a message to the user in the error error level.

Parameters:

content - the message to log.

error

void error(CharSequence content,
           Throwable error)

Send a message (and accompanying exception) to the user in the error error level.
The error's stacktrace will be output when this error level is enabled.

Parameters:

content - the message to log.

error - the error to log.

error

void error(Throwable error)

Send an exception to the user in the error error level.
The stack trace for this exception will be output when this error level is enabled.

Parameters:

error - the error to log.