Interface Logger
- All Known Implementing Classes:
WriterLogger
It is not usually necessary for users to create implementations of this interface, as
the LoggerProvider
interface contains several predefined instances which provide the most commonly required Logger
implementations.
By default, logging is configured automatically according to the algorithm described in the static Config.LoggerProvider
property.
An instance of a class that implements this interface is used by calling the Source.setLogger(Logger)
method on the relevant Source
object.
Four logging levels are defined in this interface. The logging level is specified only by the use of different method names, there is no class or type defining the levels. This makes the code required to wrap other logging frameworks much simpler and more efficient.
The four logging levels are:
IMPLEMENTATION NOTE: Ideally the java.util.logging.Logger
class could have been used as a basis for logging, even if used to define a wrapper
around other logging frameworks.
This would have avoided the need to define yet another logging interface, but because java.util.logging.Logger
is implemented very poorly,
it is quite tricky to extend it as a wrapper.
Other logging wrapper frameworks such as SLF4J or
Jakarta Commons Logging provide good logging interfaces, but to avoid
introducing dependencies it was decided to create this new interface.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Logs a message at the DEBUG level.void
Logs a message at the ERROR level.void
Logs a message at the INFO level.boolean
Indicates whether logging is enabled at the DEBUG level.boolean
Indicates whether logging is enabled at the ERROR level.boolean
Indicates whether logging is enabled at the INFO level.boolean
Indicates whether logging is enabled at the WARN level.void
Logs a message at the WARN level.
-
Method Details
-
error
Logs a message at the ERROR level.- Parameters:
message
- the message to log.
-
warn
Logs a message at the WARN level.- Parameters:
message
- the message to log.
-
info
Logs a message at the INFO level.- Parameters:
message
- the message to log.
-
debug
Logs a message at the DEBUG level.- Parameters:
message
- the message to log.
-
isErrorEnabled
boolean isErrorEnabled()Indicates whether logging is enabled at the ERROR level.- Returns:
true
if logging is enabled at the ERROR level, otherwisefalse
.
-
isWarnEnabled
boolean isWarnEnabled()Indicates whether logging is enabled at the WARN level.- Returns:
true
if logging is enabled at the WARN level, otherwisefalse
.
-
isInfoEnabled
boolean isInfoEnabled()Indicates whether logging is enabled at the INFO level.- Returns:
true
if logging is enabled at the INFO level, otherwisefalse
.
-
isDebugEnabled
boolean isDebugEnabled()Indicates whether logging is enabled at the DEBUG level.- Returns:
true
if logging is enabled at the DEBUG level, otherwisefalse
.
-