public interface
Log
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
error
fatal (the most serious)
The mapping of these log levels to the concepts used by the underlying
logging system is implementation dependent.
The implementation 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.
Since:
Author:
Juergen Hoeller (for the
spring-jcl
variant)
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.
Returns:
true if fatal is enabled in the underlying logger.
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.
Returns:
true if error is enabled in the underlying logger.
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.
Returns:
true if warn is enabled in the underlying logger.
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.
Returns:
true if info is enabled in the underlying logger.
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.
Returns:
true if debug is enabled in the underlying logger.
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.
Returns:
true if trace is enabled in the underlying logger.