| java.lang.Object
 org.jfree.util.Log
All known Subclasses: org.jfree.base.log.DefaultLog,
| Log | | public class Log (Code) | | A simple logging facility. Create a class implementing the
org.jfree.util.LogTarget interface to use this feature.
author:
Thomas Morgner |
| Inner Class :public static class SimpleMessage | |
| Constructor Summary | |
| protected | Log()
Creates a new Log instance. |
| Method Summary | |
| public synchronized void | addTarget(LogTarget target)
Adds a log target to this facility. | | public static LogContext | createContext(Class context)
Creates a log context.
Parameters:
context - the class (null not permitted). | | public static LogContext | createContext(String context)
Creates a log context.
Parameters:
context - the label for the context. | | public static void | debug(Object message)
A convenience method for logging a 'debug' message. | | public static void | debug(Object message, Exception e)
A convenience method for logging a 'debug' message. | | protected static synchronized void | defineLog(Log log)
Redefines or clears the currently used log instance. | | protected void | doLog(int level, Object message)
Logs a message to the main log stream. | | protected void | doLog(int level, Object message, Exception e)
Logs a message to the main log stream. | | public static void | error(Object message)
A convenience method for logging an 'error' message. | | public static void | error(Object message, Exception e)
A convenience method for logging an 'error' message. | | public int | getDebuglevel()
Returns the currently defined debug level. | | public static synchronized Log | getInstance()
Returns the singleton Log instance. | | public LogTarget[] | getTargets()
Returns the registered logtargets. | | public static void | info(Object message)
A convenience method for logging an 'info' message. | | public static void | info(Object message, Exception e)
A convenience method for logging an 'info' message. | | public void | init()
Initializes the logging system. | | protected LogContext | internalCreateContext(String context)
Creates a log context.
Parameters:
context - the name of the logging context (a common prefix). | | public static boolean | isDebugEnabled()
Returns true, if the log level allows debug messages to be
printed. | | public static boolean | isErrorEnabled()
Returns true, if the log level allows error messages to be
printed. | | public static boolean | isInfoEnabled()
Returns true, if the log level allows informational
messages to be printed. | | public static boolean | isWarningEnabled()
Returns true, if the log level allows warning messages to be
printed. | | public static void | log(int level, Object message)
Logs a message to the main log stream. | | public static void | log(int level, Object message, Exception e)
Logs a message to the main log stream. | | public synchronized void | removeTarget(LogTarget target)
Removes a log target from this facility. | | public synchronized void | replaceTargets(LogTarget target)
Replaces all log targets by the given target. | | protected void | setDebuglevel(int debuglevel)
Defines the debug level for the log system. | | public static void | warn(Object message)
A convenience method for logging a 'warning' message. | | public static void | warn(Object message, Exception e)
A convenience method for logging a 'warning' message. |
| Log | | protected Log()(Code) | | Creates a new Log instance. The Log is used to manage the log targets.
|
| addTarget | | public synchronized void addTarget(LogTarget target)(Code) | | Adds a log target to this facility. Log targets get informed, via the LogTarget interface,
whenever a message is logged with this class.
Parameters:
target - the target. |
| createContext | | public static LogContext createContext(Class context)(Code) | | Creates a log context.
Parameters:
context - the class (null not permitted). A log context. |
| createContext | | public static LogContext createContext(String context)(Code) | | Creates a log context.
Parameters:
context - the label for the context. A log context. |
| debug | | public static void debug(Object message)(Code) | | A convenience method for logging a 'debug' message.
Parameters:
message - the message. |
| debug | | public static void debug(Object message, Exception e)(Code) | | A convenience method for logging a 'debug' message.
Parameters:
message - the message.
Parameters:
e - the exception. |
| defineLog | | protected static synchronized void defineLog(Log log)(Code) | | Redefines or clears the currently used log instance.
Parameters:
log - the new log instance or null, to return to the default implementation. |
| doLog | | protected void doLog(int level, Object message)(Code) | | Logs a message to the main log stream. All attached log targets will also
receive this message. If the given log-level is higher than the given debug-level
in the main config file, no logging will be done.
Parameters:
level - log level of the message.
Parameters:
message - text to be logged. |
| doLog | | protected void doLog(int level, Object message, Exception e)(Code) | | Logs a message to the main log stream. All attached logTargets will also
receive this message. If the given log-level is higher than the given debug-level
in the main config file, no logging will be done.
The exception's stacktrace will be appended to the log-stream
Parameters:
level - log level of the message.
Parameters:
message - text to be logged.
Parameters:
e - the exception, which should be logged. |
| error | | public static void error(Object message)(Code) | | A convenience method for logging an 'error' message.
Parameters:
message - the message. |
| error | | public static void error(Object message, Exception e)(Code) | | A convenience method for logging an 'error' message.
Parameters:
message - the message.
Parameters:
e - the exception. |
| getDebuglevel | | public int getDebuglevel()(Code) | | Returns the currently defined debug level. The higher the level, the more details
are printed.
the debug level. |
| getInstance | | public static synchronized Log getInstance()(Code) | | Returns the singleton Log instance. A new instance is created if necessary.
the singleton instance. |
| getTargets | | public LogTarget[] getTargets()(Code) | | Returns the registered logtargets.
the logtargets. |
| info | | public static void info(Object message)(Code) | | A convenience method for logging an 'info' message.
Parameters:
message - the message. |
| info | | public static void info(Object message, Exception e)(Code) | | A convenience method for logging an 'info' message.
Parameters:
message - the message.
Parameters:
e - the exception. |
| init | | public void init()(Code) | | Initializes the logging system. Implementors should
override this method to supply their own log configuration.
|
| internalCreateContext | | protected LogContext internalCreateContext(String context)(Code) | | Creates a log context.
Parameters:
context - the name of the logging context (a common prefix). A log context. |
| isDebugEnabled | | public static boolean isDebugEnabled()(Code) | | Returns true, if the log level allows debug messages to be
printed.
true, if messages with an log level of DEBUG are allowed. |
| isErrorEnabled | | public static boolean isErrorEnabled()(Code) | | Returns true, if the log level allows error messages to be
printed.
true, if messages with an log level of ERROR are allowed. |
| isInfoEnabled | | public static boolean isInfoEnabled()(Code) | | Returns true, if the log level allows informational
messages to be printed.
true, if messages with an log level of INFO are allowed. |
| isWarningEnabled | | public static boolean isWarningEnabled()(Code) | | Returns true, if the log level allows warning messages to be
printed.
true, if messages with an log level of WARN are allowed. |
| log | | public static void log(int level, Object message)(Code) | | Logs a message to the main log stream. All attached log targets will also
receive this message. If the given log-level is higher than the given debug-level
in the main config file, no logging will be done.
Parameters:
level - log level of the message.
Parameters:
message - text to be logged. |
| log | | public static void log(int level, Object message, Exception e)(Code) | | Logs a message to the main log stream. All attached logTargets will also
receive this message. If the given log-level is higher than the given debug-level
in the main config file, no logging will be done.
The exception's stacktrace will be appended to the log-stream
Parameters:
level - log level of the message.
Parameters:
message - text to be logged.
Parameters:
e - the exception, which should be logged. |
| removeTarget | | public synchronized void removeTarget(LogTarget target)(Code) | | Removes a log target from this facility.
Parameters:
target - the target to remove. |
| replaceTargets | | public synchronized void replaceTargets(LogTarget target)(Code) | | Replaces all log targets by the given target.
Parameters:
target - the new and only logtarget. |
| setDebuglevel | | protected void setDebuglevel(int debuglevel)(Code) | | Defines the debug level for the log system.
Parameters:
debuglevel - the new debug level
See Also: Log.getDebuglevel() |
| warn | | public static void warn(Object message)(Code) | | A convenience method for logging a 'warning' message.
Parameters:
message - the message. |
| warn | | public static void warn(Object message, Exception e)(Code) | | A convenience method for logging a 'warning' message.
Parameters:
message - the message.
Parameters:
e - the exception. |
|
|