public final class Log
extends java.lang.Object
A wafer thin wrapper around System.err that uses var-args to make it much more efficient to call the logging methods in without having to surround every call site with calls to Log.isXXXEnabled(). All the methods on this class take a variable length list of arguments and, only if logging is enabled for the level and channel being logged to, will those arguments be toString()'d and appended together.
Modifier and Type | Class and Description |
---|---|
static class |
Log.LogLevel
Enumeration for setting log levels.
|
Modifier and Type | Method and Description |
---|---|
void |
debug(java.lang.Object... messageParts)
Logs one or more message parts at level debug.
|
void |
debug(java.lang.Throwable throwable,
java.lang.Object... messageParts)
Logs a Throwable and optional message parts at level debug.
|
void |
error(java.lang.Object... messageParts)
Logs one or more message parts at level error.
|
void |
error(java.lang.Throwable throwable,
java.lang.Object... messageParts)
Logs a Throwable and optional message parts at level error.
|
static Log.LogLevel |
getGlobalLogLevel()
Get the log level.
|
static java.io.PrintStream |
getGlobalPrintStream()
Get the
PrintStream for writing. |
static Log |
getInstance(java.lang.Class<?> clazz)
Get a Log instance to perform logging within the Class specified.
|
protected java.lang.String |
getTimestamp()
Creates a date string for insertion into the log.
|
void |
info(java.lang.Object... messageParts)
Logs one or more message parts at level info.
|
void |
info(java.lang.Throwable throwable,
java.lang.Object... messageParts)
Logs a Throwable and optional message parts at level info.
|
static boolean |
isEnabled(Log.LogLevel level)
Returns true if the specified log level is enabled otherwise false.
|
static void |
setGlobalLogLevel(Log.LogLevel logLevel)
Set the log level.
|
static void |
setGlobalPrintStream(java.io.PrintStream stream)
Set the
PrintStream for writing. |
void |
warn(java.lang.Object... messageParts)
Logs one or more message parts at level warn.
|
void |
warn(java.lang.Throwable throwable,
java.lang.Object... messageParts)
Logs a Throwable and optional message parts at level warn.
|
public static Log getInstance(java.lang.Class<?> clazz)
clazz
- the Class which is going to be doing the loggingpublic static void setGlobalLogLevel(Log.LogLevel logLevel)
logLevel
- The log level enumerationpublic static Log.LogLevel getGlobalLogLevel()
public static void setGlobalPrintStream(java.io.PrintStream stream)
PrintStream
for writing.stream
- PrintStream
to write to.public static java.io.PrintStream getGlobalPrintStream()
PrintStream
for writing.PrintStream
to write to.public static final boolean isEnabled(Log.LogLevel level)
protected java.lang.String getTimestamp()
public final void error(java.lang.Throwable throwable, java.lang.Object... messageParts)
throwable
- an instance of Throwable that should be logged with stack tracemessageParts
- zero or more objects which should be combined, by calling toString()
to form the log message.public final void warn(java.lang.Throwable throwable, java.lang.Object... messageParts)
throwable
- an instance of Throwable that should be logged with stack tracemessageParts
- zero or more objects which should be combined, by calling toString()
to form the log message.public final void info(java.lang.Throwable throwable, java.lang.Object... messageParts)
throwable
- an instance of Throwable that should be logged with stack tracemessageParts
- zero or more objects which should be combined, by calling toString()
to form the log message.public final void debug(java.lang.Throwable throwable, java.lang.Object... messageParts)
throwable
- an instance of Throwable that should be logged with stack tracemessageParts
- zero or more objects which should be combined, by calling toString()
to form the log message.public final void error(java.lang.Object... messageParts)
messageParts
- one or more objects which should be combined, by calling toString()
to form the log message.public final void warn(java.lang.Object... messageParts)
messageParts
- one or more objects which should be combined, by calling toString()
to form the log message.public final void info(java.lang.Object... messageParts)
messageParts
- one or more objects which should be combined, by calling toString()
to form the log message.public final void debug(java.lang.Object... messageParts)
messageParts
- one or more objects which should be combined, by calling toString()
to form the log message.