| org.apache.commons.logging.Log
All known Subclasses: org.apache.commons.logging.impl.AvalonLogger, org.apache.commons.logging.impl.NoOpLog, org.apache.commons.logging.impl.SimpleLog, org.apache.commons.logging.impl.Jdk13LumberjackLogger, org.apache.commons.logging.tccl.custom.MyLog, org.apache.commons.logging.impl.LogKitLogger, org.apache.commons.logging.impl.Jdk14Logger, org.apache.commons.logging.impl.Log4JLogger,
| Log | | public interface Log (Code) | | A simple logging interface abstracting logging APIs. In order to be
instantiated successfully by
LogFactory , classes that implement
this interface must have a constructor that takes a single String
parameter representing the "name" of this Log.
The six logging levels used by Log are (in order):
- trace (the least serious)
- debug
- info
- warn
- error
- fatal (the most serious)
The mapping of these log levels to the concepts used by the underlying
logging system is implementation dependent.
The implemention should ensure, though, that this ordering behaves
as expected.
Performance is often a logging concern.
By examining the appropriate property,
a component can avoid expensive operations (producing information
to be logged).
For example,
if (log.isDebugEnabled()) {
... do something expensive ...
log.debug(theResult);
}
Configuration of the underlying logging system will generally be done
external to the Logging APIs, through whatever mechanism is supported by
that system.
author:
Scott Sanders
author:
Rod Waldhoff
version:
$Id: Log.java 381838 2006-02-28 23:57:11Z skitching $ |
| Method Summary | |
| public void | debug(Object message)
Log a message with debug log level. | | public void | debug(Object message, Throwable t)
Log an error with debug log level. | | public void | error(Object message)
Log a message with error log level. | | public void | error(Object message, Throwable t)
Log an error with error log level. | | public void | fatal(Object message)
Log a message with fatal log level. | | public void | fatal(Object message, Throwable t)
Log an error with fatal log level. | | public void | info(Object message)
Log a message with info log level. | | public void | info(Object message, Throwable t)
Log an error with info log level. | | public boolean | isDebugEnabled()
Is debug logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than debug. | | public boolean | isErrorEnabled()
Is error logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than error. | | public boolean | isFatalEnabled()
Is fatal logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than fatal. | | public boolean | isInfoEnabled()
Is info logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than info. | | public boolean | isTraceEnabled()
Is trace logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than trace. | | public boolean | isWarnEnabled()
Is warn logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than warn. | | public void | trace(Object message)
Log a message with trace log level. | | public void | trace(Object message, Throwable t)
Log an error with trace log level. | | public void | warn(Object message)
Log a message with warn log level. | | public void | warn(Object message, Throwable t)
Log an error with warn log level. |
| debug | | public void debug(Object message)(Code) | | Log a message with debug log level.
Parameters:
message - log this message |
| debug | | public void debug(Object message, Throwable t)(Code) | | Log an error with debug log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
| error | | public void error(Object message)(Code) | | Log a message with error log level.
Parameters:
message - log this message |
| error | | public void error(Object message, Throwable t)(Code) | | Log an error with error log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
| fatal | | public void fatal(Object message)(Code) | | Log a message with fatal log level.
Parameters:
message - log this message |
| fatal | | public void fatal(Object message, Throwable t)(Code) | | Log an error with fatal log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
| info | | public void info(Object message)(Code) | | Log a message with info log level.
Parameters:
message - log this message |
| info | | public void info(Object message, Throwable t)(Code) | | Log an error with info log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
| isDebugEnabled | | public boolean isDebugEnabled()(Code) | | Is debug logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than debug.
true if debug is enabled in the underlying logger. |
| isErrorEnabled | | public boolean isErrorEnabled()(Code) | | Is error logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than error.
true if error is enabled in the underlying logger. |
| isFatalEnabled | | public boolean isFatalEnabled()(Code) | | Is fatal logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than fatal.
true if fatal is enabled in the underlying logger. |
| isInfoEnabled | | public boolean isInfoEnabled()(Code) | | Is info logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than info.
true if info is enabled in the underlying logger. |
| isTraceEnabled | | public boolean isTraceEnabled()(Code) | | Is trace logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than trace.
true if trace is enabled in the underlying logger. |
| isWarnEnabled | | public boolean isWarnEnabled()(Code) | | Is warn logging currently enabled?
Call this method to prevent having to perform expensive operations
(for example, String concatenation)
when the log level is more than warn.
true if warn is enabled in the underlying logger. |
| trace | | public void trace(Object message)(Code) | | Log a message with trace log level.
Parameters:
message - log this message |
| trace | | public void trace(Object message, Throwable t)(Code) | | Log an error with trace log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
| warn | | public void warn(Object message)(Code) | | Log a message with warn log level.
Parameters:
message - log this message |
| warn | | public void warn(Object message, Throwable t)(Code) | | Log an error with warn log level.
Parameters:
message - log this message
Parameters:
t - log this cause |
|
|