Package org.jfree.util
Class Log
java.lang.Object
org.jfree.util.Log
- Direct Known Subclasses:
DefaultLog
A simple logging facility. Create a class implementing the
LogTarget
interface to use this feature.-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a log target to this facility.static LogContext
createContext
(Class context) Creates a log context.static LogContext
createContext
(String context) Creates a log context.static void
A convenience method for logging a 'debug' message.static void
A convenience method for logging a 'debug' message.protected static void
Redefines or clears the currently used log instance.protected void
Logs a message to the main log stream.protected void
Logs a message to the main log stream.static void
A convenience method for logging an 'error' message.static void
A convenience method for logging an 'error' message.int
Returns the currently defined debug level.static Log
Returns the singleton Log instance.Returns the registered logtargets.static void
A convenience method for logging an 'info' message.static void
A convenience method for logging an 'info' message.void
init()
Initializes the logging system.protected LogContext
internalCreateContext
(String context) Creates a log context.static boolean
Returns true, if the log level allows debug messages to be printed.static boolean
Returns true, if the log level allows error messages to be printed.static boolean
Returns true, if the log level allows informational messages to be printed.static boolean
Returns true, if the log level allows warning messages to be printed.static void
Logs a message to the main log stream.static void
Logs a message to the main log stream.void
removeTarget
(LogTarget target) Removes a log target from this facility.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.static void
A convenience method for logging a 'warning' message.static void
A convenience method for logging a 'warning' message.
-
Field Details
-
debuglevel
private int debuglevelThe logging threshold. -
logTargets
Storage for the log targets. -
logContexts
The log contexts. -
singleton
the singleton instance of the Log system.
-
-
Constructor Details
-
Log
protected Log()Creates a new Log instance. The Log is used to manage the log targets.
-
-
Method Details
-
getInstance
Returns the singleton Log instance. A new instance is created if necessary.- Returns:
- the singleton instance.
-
defineLog
Redefines or clears the currently used log instance.- Parameters:
log
- the new log instance or null, to return to the default implementation.
-
getDebuglevel
public int getDebuglevel()Returns the currently defined debug level. The higher the level, the more details are printed.- Returns:
- the debug level.
-
setDebuglevel
protected void setDebuglevel(int debuglevel) Defines the debug level for the log system.- Parameters:
debuglevel
- the new debug level- See Also:
-
addTarget
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.
-
removeTarget
Removes a log target from this facility.- Parameters:
target
- the target to remove.
-
getTargets
Returns the registered logtargets.- Returns:
- the logtargets.
-
replaceTargets
Replaces all log targets by the given target.- Parameters:
target
- the new and only logtarget.
-
debug
A convenience method for logging a 'debug' message.- Parameters:
message
- the message.
-
debug
A convenience method for logging a 'debug' message.- Parameters:
message
- the message.e
- the exception.
-
info
A convenience method for logging an 'info' message.- Parameters:
message
- the message.
-
info
A convenience method for logging an 'info' message.- Parameters:
message
- the message.e
- the exception.
-
warn
A convenience method for logging a 'warning' message.- Parameters:
message
- the message.
-
warn
A convenience method for logging a 'warning' message.- Parameters:
message
- the message.e
- the exception.
-
error
A convenience method for logging an 'error' message.- Parameters:
message
- the message.
-
error
A convenience method for logging an 'error' message.- Parameters:
message
- the message.e
- the exception.
-
doLog
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.message
- text to be logged.
-
log
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.message
- text to be logged.
-
log
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.message
- text to be logged.e
- the exception, which should be logged.
-
doLog
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.message
- text to be logged.e
- the exception, which should be logged.
-
init
public void init()Initializes the logging system. Implementors should override this method to supply their own log configuration. -
isDebugEnabled
public static boolean isDebugEnabled()Returns true, if the log level allows debug messages to be printed.- Returns:
- true, if messages with an log level of DEBUG are allowed.
-
isInfoEnabled
public static boolean isInfoEnabled()Returns true, if the log level allows informational messages to be printed.- Returns:
- true, if messages with an log level of INFO are allowed.
-
isWarningEnabled
public static boolean isWarningEnabled()Returns true, if the log level allows warning messages to be printed.- Returns:
- true, if messages with an log level of WARN are allowed.
-
isErrorEnabled
public static boolean isErrorEnabled()Returns true, if the log level allows error messages to be printed.- Returns:
- true, if messages with an log level of ERROR are allowed.
-
createContext
Creates a log context.- Parameters:
context
- the class (null
not permitted).- Returns:
- A log context.
-
createContext
Creates a log context.- Parameters:
context
- the label for the context.- Returns:
- A log context.
-
internalCreateContext
Creates a log context.- Parameters:
context
- the name of the logging context (a common prefix).- Returns:
- A log context.
-