Package org.apache.maven.doxia.logging
Interface Log
-
- All Known Implementing Classes:
PlexusLoggerWrapper,SystemStreamLog
public interface LogThis interface supplies the API for providing feedback to the user from a Parser or Sink, using standardDoxiachannels.
There should be no big surprises here, although you may notice that the methods acceptjava.lang.CharSequencerather thanjava.lang.String. This is provided mainly as a convenience, to enable developers to pass things likejava.lang.StringBuilderdirectly into the logger, rather than formatting first by callingtoString().
Based onorg.apache.maven.plugin.logging.Log.- Since:
- 1.1
- Version:
- $Id$
-
-
Field Summary
Fields Modifier and Type Field Description static intLEVEL_DEBUGTypecode for debugging messages.static intLEVEL_DISABLEDTypecode for disabled log levels.static intLEVEL_ERRORTypecode for error messages.static intLEVEL_FATALTypecode for fatal error messages.static intLEVEL_INFOTypecode for informational messages.static intLEVEL_WARNTypecode for warning messages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddebug(java.lang.CharSequence content)Send a message to the user in the debug error level.voiddebug(java.lang.CharSequence content, java.lang.Throwable error)Send a message (and accompanying exception) to the user in the debug error level.voiddebug(java.lang.Throwable error)Send an exception to the user in the debug error level.voiderror(java.lang.CharSequence content)Send a message to the user in the error error level.voiderror(java.lang.CharSequence content, java.lang.Throwable error)Send a message (and accompanying exception) to the user in the error error level.voiderror(java.lang.Throwable error)Send an exception to the user in the error error level.voidinfo(java.lang.CharSequence content)Send a message to the user in the info error level.voidinfo(java.lang.CharSequence content, java.lang.Throwable error)Send a message (and accompanying exception) to the user in the info error level.voidinfo(java.lang.Throwable error)Send an exception to the user in the info error level.booleanisDebugEnabled()isDebugEnabled.booleanisErrorEnabled()isErrorEnabled.booleanisInfoEnabled()isInfoEnabled.booleanisWarnEnabled()isWarnEnabled.voidsetLogLevel(int level)Set the current log level.voidwarn(java.lang.CharSequence content)Send a message to the user in the warn error level.voidwarn(java.lang.CharSequence content, java.lang.Throwable error)Send a message (and accompanying exception) to the user in the warn error level.voidwarn(java.lang.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(java.lang.CharSequence content)
Send a message to the user in the debug error level.- Parameters:
content- the message to log.
-
debug
void debug(java.lang.CharSequence content, java.lang.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(java.lang.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(java.lang.CharSequence content)
Send a message to the user in the info error level.- Parameters:
content- the message to log.
-
info
void info(java.lang.CharSequence content, java.lang.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(java.lang.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(java.lang.CharSequence content)
Send a message to the user in the warn error level.- Parameters:
content- the message to log.
-
warn
void warn(java.lang.CharSequence content, java.lang.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(java.lang.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(java.lang.CharSequence content)
Send a message to the user in the error error level.- Parameters:
content- the message to log.
-
error
void error(java.lang.CharSequence content, java.lang.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(java.lang.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.
-
-