org.apache.commons.discovery.log

Class SimpleLog

Implemented Interfaces:
Log

public class SimpleLog
extends java.lang.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 $
Authors:
Richard A. Sitze
Scott Sanders
Rod Waldhoff
Robert Burrell Donkin

Field Summary

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 String
PROP_LEVEL
protected static DateFormat
dateFormatter
Used to format times
protected static int
logLevel
The current log level
protected String
logName
The name of this simple log instance
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(String name)
Construct a simple log with given name.

Method Summary

void
debug(Object message)
Log a message with debug log level.
void
debug(Object message, Throwable t)
Log an error with debug log level.
void
error(Object message)
Log a message with error log level.
void
error(Object message, Throwable t)
Log an error with error log level.
void
fatal(Object message)
Log a message with fatal log level.
void
fatal(Object message, Throwable t)
Log an error with fatal log level.
static int
getLevel()
Get logging level.
void
info(Object message)
Log a message with info log level.
void
info(Object message, Throwable t)
Log an error with info log level.
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.

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.

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.

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.

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

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.

protected void
log(int type, Object message, Throwable t)
Do the actual logging.
static void
setLevel(int currentLogLevel)
Set logging level.
void
trace(Object message)
Log a message with debug log level.
void
trace(Object message, Throwable t)
Log an error with debug log level.
void
warn(Object message)
Log a message with warn log level.
void
warn(Object message, Throwable t)
Log an error with warn log level.

Field Details

LOG_LEVEL_ALL

public static final int LOG_LEVEL_ALL
Enable all logging levels
Field Value:
0

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG
"Debug" level logging.
Field Value:
2

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR
"Error" level logging.
Field Value:
5

LOG_LEVEL_FATAL

public static final int LOG_LEVEL_FATAL
"Fatal" level logging.
Field Value:
6

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO
"Info" level logging.
Field Value:
3

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF
Enable no logging levels
Field Value:
7

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE
"Trace" level logging.
Field Value:
1

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN
"Warn" level logging.
Field Value:
4

PROP_LEVEL

protected static final String PROP_LEVEL

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

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 Details

SimpleLog

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

Method Details

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