Package 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
There should be no big surprises here, although you may notice that the methods accept
Based on
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.StringBuilder
directly into the logger,
rather than formatting first by calling toString()
.
Based on
org.apache.maven.plugin.logging.Log
.- Since:
- 1.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Typecode for debugging messages.static final int
Typecode for disabled log levels.static final int
Typecode for error messages.static final int
Typecode for fatal error messages.static final int
Typecode for informational messages.static final int
Typecode for warning messages. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
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
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
Send an exception to the user in the info error level.boolean
isDebugEnabled.boolean
isErrorEnabled.boolean
isInfoEnabled.boolean
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
Send an exception to the user in the warn error level.
-
Field Details
-
LEVEL_DEBUG
static final int LEVEL_DEBUGTypecode for debugging messages.- See Also:
-
LEVEL_INFO
static final int LEVEL_INFOTypecode for informational messages.- See Also:
-
LEVEL_WARN
static final int LEVEL_WARNTypecode for warning messages.- See Also:
-
LEVEL_ERROR
static final int LEVEL_ERRORTypecode for error messages.- See Also:
-
LEVEL_FATAL
static final int LEVEL_FATALTypecode for fatal error messages.- See Also:
-
LEVEL_DISABLED
static final int LEVEL_DISABLEDTypecode for disabled log levels.- See Also:
-
-
Method Details
-
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
Send a message to the user in the debug error level.- Parameters:
content
- the message to log.
-
debug
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
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
Send a message to the user in the info error level.- Parameters:
content
- the message to log.
-
info
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
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
Send a message to the user in the warn error level.- Parameters:
content
- the message to log.
-
warn
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
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
Send a message to the user in the error error level.- Parameters:
content
- the message to log.
-
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
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.
-