Interface Log
- All Known Implementing Classes:
AvalonLogger,Jdk13LumberjackLogger,Jdk14Logger,Log4JLogger,LogKitLogger,NoOpLog,SimpleLog
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)
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.
-
Method Summary
Modifier and TypeMethodDescriptionvoidLogs a message with debug log level.voidLogs an error with debug log level.voidLogs a message with error log level.voidLogs an error with error log level.voidLogs a message with fatal log level.voidLogs an error with fatal log level.voidLogs a message with info log level.voidLogs an error with info log level.booleanIs debug logging currently enabled?booleanIs error logging currently enabled?booleanIs fatal logging currently enabled?booleanIs info logging currently enabled?booleanIs trace logging currently enabled?booleanIs warn logging currently enabled?voidLogs a message with trace log level.voidLogs an error with trace log level.voidLogs a message with warn log level.voidLogs an error with warn log level.
-
Method Details
-
debug
Logs a message with debug log level.- Parameters:
message- log this message
-
debug
Logs an error with debug log level.- Parameters:
message- log this messaget- log this cause
-
error
Logs a message with error log level.- Parameters:
message- log this message
-
error
Logs an error with error log level.- Parameters:
message- log this messaget- log this cause
-
fatal
Logs a message with fatal log level.- Parameters:
message- log this message
-
fatal
Logs an error with fatal log level.- Parameters:
message- log this messaget- log this cause
-
info
Logs a message with info log level.- Parameters:
message- log this message
-
info
Logs an error with info log level.- Parameters:
message- log this messaget- log this cause
-
isDebugEnabled
boolean isDebugEnabled()Is debug logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than debug.- Returns:
- true if debug is enabled in the underlying logger.
-
isErrorEnabled
boolean isErrorEnabled()Is error logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than error.- Returns:
- true if error is enabled in the underlying logger.
-
isFatalEnabled
boolean isFatalEnabled()Is fatal logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than fatal.- Returns:
- true if fatal is enabled in the underlying logger.
-
isInfoEnabled
boolean isInfoEnabled()Is info logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than info.- Returns:
- true if info is enabled in the underlying logger.
-
isTraceEnabled
boolean isTraceEnabled()Is trace logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than trace.- Returns:
- true if trace is enabled in the underlying logger.
-
isWarnEnabled
boolean isWarnEnabled()Is warn logging currently enabled?Call this method to prevent having to perform expensive operations (for example,
Stringconcatenation) when the log level is more than warn.- Returns:
- true if warn is enabled in the underlying logger.
-
trace
Logs a message with trace log level.- Parameters:
message- log this message
-
trace
Logs an error with trace log level.- Parameters:
message- log this messaget- log this cause
-
warn
Logs a message with warn log level.- Parameters:
message- log this message
-
warn
Logs an error with warn log level.- Parameters:
message- log this messaget- log this cause
-