org.apache.commons.discovery.log
Class SimpleLog

java.lang.Object
  |
  +--org.apache.commons.discovery.log.SimpleLog

All Implemented Interfaces:

org.apache.commons.logging.Log

public class SimpleLog

extends java.lang.Object

implements org.apache.commons.logging.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,v 1.4 2002/06/15 20:54:48 craigmcc Exp $

Author:

Richard A. Sitze, Scott Sanders, Rod Waldhoff, Robert Burrell Donkin

Field Summary

protected static java.text.DateFormat	dateFormatter Used to format times
static int	LOG_LEVEL_ALL Enable all logging levels
static int	LOG_LEVEL_DEBUG "Debug" level logging.
static int	LOG_LEVEL_ERROR "Error" level logging.
static int	LOG_LEVEL_FATAL "Fatal" level logging.
static int	LOG_LEVEL_INFO "Info" level logging.
static int	LOG_LEVEL_OFF Enable no logging levels
static int	LOG_LEVEL_TRACE "Trace" level logging.
static int	LOG_LEVEL_WARN "Warn" level logging.
protected static int	logLevel The current log level
protected java.lang.String	logName The name of this simple log instance
protected static java.lang.String	PROP_LEVEL
protected static boolean	showDateTime Include the current time in the log message
protected static boolean	showLogName Include the instance name in the log message?
protected static boolean	showShortName Include the short name ( last component ) of the logger in the log message.

Constructor Summary

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

Method Summary

void	debug(java.lang.Object message) Log a message with debug log level.
void	debug(java.lang.Object message, java.lang.Throwable t) Log an error with debug log level.
void	error(java.lang.Object message) Log a message with error log level.
void	error(java.lang.Object message, java.lang.Throwable t) Log an error with error log level.
void	fatal(java.lang.Object message) Log a message with fatal log level.
void	fatal(java.lang.Object message, java.lang.Throwable t) Log an error with fatal log level.
static int	getLevel() Get logging level.
void	info(java.lang.Object message) Log a message with info log level.
void	info(java.lang.Object message, java.lang.Throwable t) Log an error with info log level.
boolean	isDebugEnabled() Are debug messages currently enabled?
boolean	isErrorEnabled() Are error messages currently enabled?
boolean	isFatalEnabled() Are fatal messages currently enabled?
boolean	isInfoEnabled() Are info messages currently enabled?
protected static boolean	isLevelEnabled(int level) Is the given log level currently enabled?
boolean	isTraceEnabled() Are trace messages currently enabled?
boolean	isWarnEnabled() Are warn messages currently enabled?
protected void	log(int type, java.lang.Object message, java.lang.Throwable t) Do the actual logging.
static void	setLevel(int currentLogLevel) Set logging level.
void	trace(java.lang.Object message) Log a message with debug log level.
void	trace(java.lang.Object message, java.lang.Throwable t) Log an error with debug log level.
void	warn(java.lang.Object message) Log a message with warn log level.
void	warn(java.lang.Object message, java.lang.Throwable t) Log an error with warn log level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE

"Trace" level logging.

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG

"Debug" level logging.

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO

"Info" level logging.

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN

"Warn" 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_ALL

public static final int LOG_LEVEL_ALL

Enable all logging levels

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF

Enable no logging levels

PROP_LEVEL

protected static final java.lang.String PROP_LEVEL

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.

showDateTime

protected static boolean showDateTime

Include the current time in the log message

dateFormatter

protected static java.text.DateFormat dateFormatter

Used to format times

logLevel

protected static int logLevel

The current log level

logName

protected java.lang.String logName

The name of this simple log instance

Constructor Detail

SimpleLog

public SimpleLog(java.lang.String name)

Construct a simple log with given name.

Parameters:

name - log name

Method Detail

setLevel

public static void setLevel(int currentLogLevel)

Set logging level.

Parameters:

level - new logging level

getLevel

public static int getLevel()

Get logging level.

isLevelEnabled

protected static boolean isLevelEnabled(int level)

Is the given log level currently enabled?

Parameters:

logLevel - is this level enabled?

log

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

Do the actual logging. This method assembles the message and then prints to System.err.

debug

public final void debug(java.lang.Object message)

Log a message with debug log level.

Specified by:

debug in interface org.apache.commons.logging.Log

debug

public final void debug(java.lang.Object message,
                        java.lang.Throwable t)

Log an error with debug log level.

Specified by:

debug in interface org.apache.commons.logging.Log

trace

public final void trace(java.lang.Object message)

Log a message with debug log level.

Specified by:

trace in interface org.apache.commons.logging.Log

trace

public final void trace(java.lang.Object message,
                        java.lang.Throwable t)

Log an error with debug log level.

Specified by:

trace in interface org.apache.commons.logging.Log

info

public final void info(java.lang.Object message)

Log a message with info log level.

Specified by:

info in interface org.apache.commons.logging.Log

info

public final void info(java.lang.Object message,
                       java.lang.Throwable t)

Log an error with info log level.

Specified by:

info in interface org.apache.commons.logging.Log

warn

public final void warn(java.lang.Object message)

Log a message with warn log level.

Specified by:

warn in interface org.apache.commons.logging.Log

warn

public final void warn(java.lang.Object message,
                       java.lang.Throwable t)

Log an error with warn log level.

Specified by:

warn in interface org.apache.commons.logging.Log

error

public final void error(java.lang.Object message)

Log a message with error log level.

Specified by:

error in interface org.apache.commons.logging.Log

error

public final void error(java.lang.Object message,
                        java.lang.Throwable t)

Log an error with error log level.

Specified by:

error in interface org.apache.commons.logging.Log

fatal

public final void fatal(java.lang.Object message)

Log a message with fatal log level.

Specified by:

fatal in interface org.apache.commons.logging.Log

fatal

public final void fatal(java.lang.Object message,
                        java.lang.Throwable t)

Log an error with fatal log level.

Specified by:

fatal in interface org.apache.commons.logging.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.

Specified by:

isDebugEnabled in interface org.apache.commons.logging.Log

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.

Specified by:

isErrorEnabled in interface org.apache.commons.logging.Log

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.

Specified by:

isFatalEnabled in interface org.apache.commons.logging.Log

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.

Specified by:

isInfoEnabled in interface org.apache.commons.logging.Log

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.

Specified by:

isTraceEnabled in interface org.apache.commons.logging.Log

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.

Specified by:

isWarnEnabled in interface org.apache.commons.logging.Log