org.apache.commons.discovery.log

Class SimpleLog

public class SimpleLog extends Object implements Log

Simple implementation of Log that sends all enabled log messages, for all defined loggers, to System.err.

Hacked from commons-logging SimpleLog for use in discovery. This is intended to be enough of a Log implementation to bootstrap Discovery.

One property: org.apache.commons.discovery.log.level. valid values: all, trace, debug, info, warn, error, fatal, off.

Version: $Id: SimpleLog.java 480374 2006-11-29 03:33:25Z niallp $

Author: Richard A. Sitze Scott Sanders Rod Waldhoff Robert Burrell Donkin

Field Summary
protected static DateFormatdateFormatter
Used to format times
protected static intlogLevel
The current log level
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 StringPROP_LEVEL
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.
Constructor Summary
SimpleLog(String name)
Construct a simple log with given name.
Method Summary
voiddebug(Object message)

Log a message with debug log level.

voiddebug(Object message, Throwable t)

Log an error with debug log level.

voiderror(Object message)

Log a message with error log level.

voiderror(Object message, Throwable t)

Log an error with error log level.

voidfatal(Object message)

Log a message with fatal log level.

voidfatal(Object message, Throwable t)

Log an error with fatal log level.

static intgetLevel()

Get logging level.

voidinfo(Object message)

Log a message with info log level.

voidinfo(Object message, Throwable t)

Log an error with info log level.

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 static booleanisLevelEnabled(int level)
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.

static voidsetLevel(int currentLogLevel)

Set logging level.

voidtrace(Object message)

Log a message with debug log level.

voidtrace(Object message, Throwable t)

Log an error with debug log level.

voidwarn(Object message)

Log a message with warn log level.

voidwarn(Object message, Throwable t)

Log an error with warn log level.

Field Detail

dateFormatter

protected static DateFormat dateFormatter
Used to format times

logLevel

protected static int logLevel
The current log level

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.

PROP_LEVEL

protected static final String PROP_LEVEL

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. Default to true - otherwise we'll be lost in a flood of messages without knowing who sends them.

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)

Log a message with debug log level.

debug

public final void debug(Object message, Throwable t)

Log an error with debug log level.

error

public final void error(Object message)

Log a message with error log level.

error

public final void error(Object message, Throwable t)

Log an error with error log level.

fatal

public final void fatal(Object message)

Log a message with fatal log level.

fatal

public final void fatal(Object message, Throwable t)

Log an error with fatal log level.

getLevel

public static int getLevel()

Get logging level.

info

public final void info(Object message)

Log a message with info log level.

info

public final void info(Object message, Throwable t)

Log an error with info log level.

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 static boolean isLevelEnabled(int level)
Is the given log level currently enabled?

Parameters: level 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 prints to System.err.

setLevel

public static void setLevel(int currentLogLevel)

Set logging level.

Parameters: currentLogLevel new logging level

trace

public final void trace(Object message)

Log a message with debug log level.

trace

public final void trace(Object message, Throwable t)

Log an error with debug log level.

warn

public final void warn(Object message)

Log a message with warn log level.

warn

public final void warn(Object message, Throwable t)

Log an error with warn log level.

Copyright (c) 2002 - Apache Software Foundation