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):
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.
Please note that this interface is identical to that found in JCL 1.1.1.
Modifier and Type | Method and Description |
---|---|
void |
debug(Object message)
Log a message with debug log level.
|
void |
debug(Object message,
Throwable t)
Log an error with debug log level.
|
void |
error(Object message)
Log a message with error log level.
|
void |
error(Object message,
Throwable t)
Log an error with error log level.
|
void |
fatal(Object message)
Log a message with fatal log level.
|
void |
fatal(Object message,
Throwable t)
Log an error with fatal log level.
|
void |
info(Object message)
Log a message with info log level.
|
void |
info(Object message,
Throwable t)
Log an error with info log level.
|
boolean |
isDebugEnabled()
Is debug logging currently enabled?
|
boolean |
isErrorEnabled()
Is error logging currently enabled?
|
boolean |
isFatalEnabled()
Is fatal logging currently enabled?
|
boolean |
isInfoEnabled()
Is info logging currently enabled?
|
boolean |
isTraceEnabled()
Is trace logging currently enabled?
|
boolean |
isWarnEnabled()
Is warn logging currently enabled?
|
void |
trace(Object message)
Log a message with trace log level.
|
void |
trace(Object message,
Throwable t)
Log an error with trace log level.
|
void |
warn(Object message)
Log a message with warn log level.
|
void |
warn(Object message,
Throwable t)
Log an error with warn log level.
|
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.
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.
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.
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.
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.
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.
void trace(Object message)
Log a message with trace log level.
message
- log this messagevoid trace(Object message, Throwable t)
Log an error with trace log level.
message
- log this messaget
- log this causevoid debug(Object message)
Log a message with debug log level.
message
- log this messagevoid debug(Object message, Throwable t)
Log an error with debug log level.
message
- log this messaget
- log this causevoid info(Object message)
Log a message with info log level.
message
- log this messagevoid info(Object message, Throwable t)
Log an error with info log level.
message
- log this messaget
- log this causevoid warn(Object message)
Log a message with warn log level.
message
- log this messagevoid warn(Object message, Throwable t)
Log an error with warn log level.
message
- log this messaget
- log this causevoid error(Object message)
Log a message with error log level.
message
- log this messagevoid error(Object message, Throwable t)
Log an error with error log level.
message
- log this messaget
- log this causevoid fatal(Object message)
Log a message with fatal log level.
message
- log this messageCopyright © 2018 JBoss by Red Hat. All rights reserved.