Class SimpleLog
- All Implemented Interfaces:
Serializable
,Log
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:
org.apache.commons.logging.simplelog.defaultlog
- Default logging detail level for all instances of SimpleLog. Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, defaults to "info".org.apache.commons.logging.simplelog.log.xxxxx
- Logging detail level for a SimpleLog instance named "xxxxx". Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, the default logging detail level is used.org.apache.commons.logging.simplelog.showlogname
- Set totrue
if you want the Log instance name to be included in output messages. Defaults tofalse
.org.apache.commons.logging.simplelog.showShortLogname
- Set totrue
if you want the last component of the name to be included in output messages. Defaults totrue
.org.apache.commons.logging.simplelog.showdatetime
- Set totrue
if you want the current date and time to be included in output messages. Default isfalse
.org.apache.commons.logging.simplelog.dateTimeFormat
- The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used injava.text.SimpleDateFormat
. If the format is not specified or is invalid, the default format is used. The default format isyyyy/MM/dd HH:mm:ss:SSS zzz
.
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).
- Version:
- $Id: SimpleLog.java,v 1.21 2004/06/06 20:47:56 rdonkin Exp $
- Author:
- Scott Sanders, Rod Waldhoff, Robert Burrell Donkin
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
The current log levelprotected static DateFormat
Used to format timesprotected static String
The date and time format to use in the log messageprotected static final String
The default format to use when formatting datesstatic final int
Enable all logging levelsstatic final int
"Debug" level logging.static final int
"Error" level logging.static final int
"Fatal" level logging.static final int
"Info" level logging.static final int
Enable no logging levelsstatic final int
"Trace" level logging.static final int
"Warn" level logging.protected String
The name of this simple log instanceprotected static boolean
Include the current time in the log messageprotected static boolean
Include the instance name in the log message?protected static boolean
Include the short name ( last component ) of the logger in the log message.protected static final Properties
Properties loaded from simplelog.propertiesprotected static final String
All system properties used bySimpleLog
start with this -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
Log a message with debug log level.final void
Log an error with debug log level.final void
Log a message with error log level.final void
Log an error with error log level.final void
Log a message with fatal log level.final void
Log an error with fatal log level.int
getLevel()
Get logging level.final void
Log a message with info log level.final void
Log an error with info log level.final boolean
Are debug messages currently enabled?final boolean
Are error messages currently enabled?final boolean
Are fatal messages currently enabled?final boolean
Are info messages currently enabled?protected boolean
isLevelEnabled
(int logLevel) Is the given log level currently enabled?final boolean
Are trace messages currently enabled?final boolean
Are warn messages currently enabled?protected void
Do the actual logging.void
setLevel
(int currentLogLevel) Set logging level.final void
Log a message with trace log level.final void
Log an error with trace log level.final void
Log a message with warn log level.final void
Log an error with warn log level.protected void
write
(StringBuffer buffer) Write the content of the message accumulated in the specifiedStringBuffer
to the appropriate output destination.
-
Field Details
-
systemPrefix
All system properties used bySimpleLog
start with this- See Also:
-
simpleLogProps
Properties loaded from simplelog.properties -
DEFAULT_DATE_TIME_FORMAT
The default format to use when formatting dates- See Also:
-
showLogName
Include the instance name in the log message? -
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. -
showDateTime
Include the current time in the log message -
dateTimeFormat
The date and time format to use in the log message -
dateFormatter
Used to format times -
LOG_LEVEL_TRACE
"Trace" level logging.- See Also:
-
LOG_LEVEL_DEBUG
"Debug" level logging.- See Also:
-
LOG_LEVEL_INFO
"Info" level logging.- See Also:
-
LOG_LEVEL_WARN
"Warn" level logging.- See Also:
-
LOG_LEVEL_ERROR
"Error" level logging.- See Also:
-
LOG_LEVEL_FATAL
"Fatal" level logging.- See Also:
-
LOG_LEVEL_ALL
Enable all logging levels- See Also:
-
LOG_LEVEL_OFF
Enable no logging levels- See Also:
-
logName
The name of this simple log instance -
currentLogLevel
The current log level
-
-
Constructor Details
-
SimpleLog
Construct a simple log with given name.- Parameters:
name
- log name
-
-
Method Details
-
setLevel
Set logging level.
- Parameters:
currentLogLevel
- new logging level
-
getLevel
Get logging level.
-
log
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 levelmessage
- The message itself (typically a String)t
- The exception whose stack trace should be logged
-
write
Write the content of the message accumulated in the specified
StringBuffer
to the appropriate output destination. The default implementation writes toSystem.err
.- Parameters:
buffer
- AStringBuffer
containing the accumulated text to be logged
-
isLevelEnabled
Is the given log level currently enabled?- Parameters:
logLevel
- is this level enabled?
-
debug
Log a message with debug log level.
-
debug
Log an error with debug log level.
-
trace
Log a message with trace log level.
-
trace
Log an error with trace log level.
-
info
Log a message with info log level.
-
info
Log an error with info log level.
-
warn
Log a message with warn log level.
-
warn
Log an error with warn log level.
-
error
Log a message with error log level.
-
error
Log an error with error log level.
-
fatal
Log a message with fatal log level.
-
fatal
Log an error with fatal log level.
-
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 interfaceLog
-
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 interfaceLog
-
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 interfaceLog
-
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 interfaceLog
- Returns:
- true if info enabled, false otherwise
-
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 interfaceLog
- Returns:
- true if trace enabled, false otherwise
-
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 interfaceLog
-