public static final class DOF.Log
extends java.lang.Object
DOF.Log
) and receiving (DOF.Log.Listener
) log messages.
The OAL will add to the logs by calling the message(org.opendof.core.oal.DOF.Log.Level, java.lang.String)
methods. The application controls how messages are logged
and which ones are logged.
Use this class in two steps:
DOF.Log.Listener
. There you can specify where to send the log (for example, by calling
System.out.println or by stuffing a database). You can also filter out the ones you don't want by checking the
moduleName and level in DOF.Log.Listener.logMessage(java.util.Date, org.opendof.core.oal.DOF.Log.Level, java.lang.String, java.lang.Throwable)
.addListener(org.opendof.core.oal.DOF.Log.Level, org.opendof.core.oal.DOF.Log.Listener)
for each kind you want like this:
DOF.Log.addListener(DOF.Log.Level.DEBUG, myLogListener);
Modifier and Type | Class and Description |
---|---|
static class |
DOF.Log.Level
Logging priority levels.
|
static interface |
DOF.Log.Listener
The DOF.Log.Listener interface enables you to receive log messages when implemented.
|
Modifier and Type | Method and Description |
---|---|
static void |
addListener(DOF.Log.Level level,
DOF.Log.Listener listener)
Adds a listener to receive log messages.
|
static boolean |
isLogDebug()
Returns true if anyone is listening for DEBUG level messages.
|
static boolean |
isLogError()
Returns true if anyone is listening for ERROR level messages.
|
static boolean |
isLogFatal()
Returns true if there are any registered listeners at any level.
|
static boolean |
isLogInfo()
Returns true if anyone is listening for INFO level messages.
|
static boolean |
isLogLevel(DOF.Log.Level level)
Returns true if anyone is listening for messages at a priority level lower than or equal to the specified.
|
static boolean |
isLogTrace()
Returns true if anyone is listening for TRACE level messages.
|
static boolean |
isLogWarn()
Returns true if anyone is listening for WARN level messages.
|
static void |
message(DOF.Log.Level level,
java.lang.String message)
Logs a message.
|
static void |
message(DOF.Log.Level level,
java.lang.String message,
java.lang.Throwable t)
Logs a message.
|
static void |
message(java.lang.String moduleName,
DOF.Log.Level level,
java.lang.String message)
Logs a message.
|
static void |
message(java.lang.String moduleName,
DOF.Log.Level level,
java.lang.String message,
java.lang.Throwable t)
Logs a message.
|
static void |
removeListener(DOF.Log.Listener listener)
Removes a listener.
|
public static void addListener(DOF.Log.Level level, DOF.Log.Listener listener)
level
- The logging priority level for which messages should be sent to this listener.listener
- The listener to add.removeListener(Listener)
public static void removeListener(DOF.Log.Listener listener)
listener
- The listener to remove.public static boolean isLogLevel(DOF.Log.Level level)
level
- This message's priority level.public static boolean isLogFatal()
public static boolean isLogError()
public static boolean isLogDebug()
public static boolean isLogInfo()
public static boolean isLogWarn()
public static boolean isLogTrace()
public static void message(DOF.Log.Level level, java.lang.String message)
level
- This message's priority level.message
- The message.public static void message(DOF.Log.Level level, java.lang.String message, java.lang.Throwable t)
level
- This message's priority level.message
- The message.t
- A throwable that goes with this message.public static void message(java.lang.String moduleName, DOF.Log.Level level, java.lang.String message)
moduleName
- The module name that produced this message.level
- This message's priority level.message
- The message.public static void message(java.lang.String moduleName, DOF.Log.Level level, java.lang.String message, java.lang.Throwable t)
moduleName
- The module name that produced this message.level
- This message's priority level.message
- The message.t
- A throwable that goes with this message.