org.apache.commons.logging.impl

Class SimpleLog

public class SimpleLog extends Object implements Log, Serializable

Simple implementation of Log that sends all enabled log messages, for all defined loggers, to System.err. The following system properties are supported to configure the behavior of this logger:

In addition to looking for system properties with the names specified above, this implementation also checks for a class loader resource named "simplelog.properties", and includes any matching definitions from this resource (if it exists).

Field Summary
protected intcurrentLogLevel
The current log level
protected static DateFormatdateFormatter
Used to format times
protected static StringdateTimeFormat
The date and time format to use in the log message
protected static StringDEFAULT_DATE_TIME_FORMAT
The default format to use when formating dates
protected StringlogName
The name of this simple log instance
static intLOG_LEVEL_ALL
Enable all logging levels
static intLOG_LEVEL_DEBUG
"Debug" level logging.
static intLOG_LEVEL_ERROR
"Error" level logging.
static intLOG_LEVEL_FATAL
"Fatal" level logging.
static intLOG_LEVEL_INFO
"Info" level logging.
static intLOG_LEVEL_OFF
Enable no logging levels
static intLOG_LEVEL_TRACE
"Trace" level logging.
static intLOG_LEVEL_WARN
"Warn" level logging.
protected static booleanshowDateTime
Include the current time in the log message
protected static booleanshowLogName
Include the instance name in the log message?
protected static booleanshowShortName
Include the short name ( last component ) of the logger in the log message.
protected static PropertiessimpleLogProps
Properties loaded from simplelog.properties
protected static StringsystemPrefix
All system properties used by SimpleLog start with this
Constructor Summary
SimpleLog(String name)
Construct a simple log with given name.
Method Summary
voiddebug(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.
voiddebug(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.
voiderror(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.
voiderror(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.
voidfatal(Object message)
Log a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.
voidfatal(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.
intgetLevel()

Get logging level.

voidinfo(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.
voidinfo(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.
booleanisDebugEnabled()

Are debug messages currently enabled?

booleanisErrorEnabled()

Are error messages currently enabled?

booleanisFatalEnabled()

Are fatal messages currently enabled?

booleanisInfoEnabled()

Are info messages currently enabled?

protected booleanisLevelEnabled(int logLevel)
Is the given log level currently enabled?
booleanisTraceEnabled()

Are trace messages currently enabled?

booleanisWarnEnabled()

Are warn messages currently enabled?

protected voidlog(int type, Object message, Throwable t)

Do the actual logging.

voidsetLevel(int currentLogLevel)

Set logging level.

voidtrace(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.
voidtrace(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.
voidwarn(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.
voidwarn(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.
protected voidwrite(StringBuffer buffer)

Write the content of the message accumulated in the specified StringBuffer to the appropriate output destination.

Field Detail

currentLogLevel

protected int currentLogLevel
The current log level

dateFormatter

protected static DateFormat dateFormatter
Used to format times

dateTimeFormat

protected static String dateTimeFormat
The date and time format to use in the log message

DEFAULT_DATE_TIME_FORMAT

protected static final String DEFAULT_DATE_TIME_FORMAT
The default format to use when formating dates

logName

protected String logName
The name of this simple log instance

LOG_LEVEL_ALL

public static final int LOG_LEVEL_ALL
Enable all logging levels

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG
"Debug" level logging.

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR
"Error" level logging.

LOG_LEVEL_FATAL

public static final int LOG_LEVEL_FATAL
"Fatal" level logging.

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO
"Info" level logging.

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF
Enable no logging levels

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE
"Trace" level logging.

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN
"Warn" level logging.

showDateTime

protected static boolean showDateTime
Include the current time in the log message

showLogName

protected static boolean showLogName
Include the instance name in the log message?

showShortName

protected static boolean showShortName
Include the short name ( last component ) of the logger in the log message. Defaults to true - otherwise we'll be lost in a flood of messages without knowing who sends them.

simpleLogProps

protected static final Properties simpleLogProps
Properties loaded from simplelog.properties

systemPrefix

protected static final String systemPrefix
All system properties used by SimpleLog start with this

Constructor Detail

SimpleLog

public SimpleLog(String name)
Construct a simple log with given name.

Parameters: name log name

Method Detail

debug

public final void debug(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.

Parameters: message to log

See Also: debug

debug

public final void debug(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.

Parameters: message to log t log this cause

See Also: Log

error

public final void error(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.

Parameters: message to log

See Also: error

error

public final void error(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.

Parameters: message to log t log this cause

See Also: Log

fatal

public final void fatal(Object message)
Log a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.

Parameters: message to log

See Also: fatal

fatal

public final void fatal(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.

Parameters: message to log t log this cause

See Also: Log

getLevel

public int getLevel()

Get logging level.

info

public final void info(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.

Parameters: message to log

See Also: info

info

public final void info(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.

Parameters: message to log t log this cause

See Also: Log

isDebugEnabled

public final boolean isDebugEnabled()

Are debug messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

isErrorEnabled

public final boolean isErrorEnabled()

Are error messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

isFatalEnabled

public final boolean isFatalEnabled()

Are fatal messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

isInfoEnabled

public final boolean isInfoEnabled()

Are info messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

isLevelEnabled

protected boolean isLevelEnabled(int logLevel)
Is the given log level currently enabled?

Parameters: logLevel is this level enabled?

isTraceEnabled

public final boolean isTraceEnabled()

Are trace messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

isWarnEnabled

public final boolean isWarnEnabled()

Are warn messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

log

protected void log(int type, Object message, Throwable t)

Do the actual logging. This method assembles the message and then calls write() to cause it to be written.

Parameters: type One of the LOG_LEVEL_XXX constants defining the log level message The message itself (typically a String) t The exception whose stack trace should be logged

setLevel

public void setLevel(int currentLogLevel)

Set logging level.

Parameters: currentLogLevel new logging level

trace

public final void trace(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.

Parameters: message to log

See Also: trace

trace

public final void trace(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.

Parameters: message to log t log this cause

See Also: Log

warn

public final void warn(Object message)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.

Parameters: message to log

See Also: warn

warn

public final void warn(Object message, Throwable t)
Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.

Parameters: message to log t log this cause

See Also: Log

write

protected void write(StringBuffer buffer)

Write the content of the message accumulated in the specified StringBuffer to the appropriate output destination. The default implementation writes to System.err.

Parameters: buffer A StringBuffer containing the accumulated text to be logged