Class SimpleLog
- All Implemented Interfaces:
Serializable,Log
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 totrueif you want the Log instance name to be included in output messages. Defaults tofalse.org.apache.commons.logging.simplelog.showShortLogname- Set totrueif you want the last component of the name to be included in output messages. Defaults totrue.org.apache.commons.logging.simplelog.showdatetime- Set totrueif 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 inSimpleDateFormat. 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).
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe current log levelprotected static DateFormatUsed to format times.protected static StringThe date and time format to use in the log messageprotected static final StringThe default format to use when formating datesstatic final intEnable 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 intEnable no logging levelsstatic final int"Trace" level logging.static final int"Warn" level logging.protected StringThe name of this simple log instanceprotected static booleanInclude the current time in the log messageprotected static booleanInclude the instance name in the log message?protected static booleanInclude the short name (last component) of the logger in the log message.protected static final PropertiesProperties loaded from simplelog.propertiesprotected static final StringAll system properties used bySimpleLogstart with this -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.final voidLogs a message withorg.apache.commons.logging.impl.LOG_LEVEL_DEBUG.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.final voidLog a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.intgetLevel()Gets logging level.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.final booleanTests whether debug messages are enabled.final booleanTests whether error messages are enabled.final booleanTests whether fatal messages are enabled.final booleanTests whether info messages are enabled.protected booleanisLevelEnabled(int logLevel) Tests whether the given level is enabled.final booleanTests whether trace messages are enabled.final booleanTests whether warn messages are enabled.protected voidDo the actual logging.voidsetLevel(int currentLogLevel) Sets logging level.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.final voidLogs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.protected voidwrite(StringBuffer buffer) Writes the content of the message accumulated in the specifiedStringBufferto the appropriate output destination.
-
Field Details
-
systemPrefix
All system properties used bySimpleLogstart with this- See Also:
-
simpleLogProps
Properties loaded from simplelog.properties -
DEFAULT_DATE_TIME_FORMAT
The default format to use when formating 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.Any code that accesses this object should first obtain a lock on it, that is, use synchronized(dateFormatter); this requirement was introduced in 1.1.1 to fix an existing thread safety bug (SimpleDateFormat.format is not thread-safe).
-
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
Constructs a simple log with given name.- Parameters:
name- log name
-
-
Method Details
-
debug
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG. -
debug
Logs a message withorg.apache.commons.logging.impl.LOG_LEVEL_DEBUG. -
error
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR. -
error
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR. -
fatal
Log a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL. -
fatal
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL. -
getLevel
Gets logging level.- Returns:
- logging level.
-
info
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO. -
info
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO. -
isDebugEnabled
Tests whether debug messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isDebugEnabledin interfaceLog- Returns:
- true if debug is enabled in the underlying logger.
-
isErrorEnabled
Tests whether error messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isErrorEnabledin interfaceLog- Returns:
- true if error is enabled in the underlying logger.
-
isFatalEnabled
Tests whether fatal messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isFatalEnabledin interfaceLog- Returns:
- true if fatal is enabled in the underlying logger.
-
isInfoEnabled
Tests whether info messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isInfoEnabledin interfaceLog- Returns:
- true if info is enabled in the underlying logger.
-
isLevelEnabled
Tests whether the given level is enabled.- Parameters:
logLevel- is this level enabled?- Returns:
- whether the given log level currently enabled.
-
isTraceEnabled
Tests whether trace messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isTraceEnabledin interfaceLog- Returns:
- true if trace is enabled in the underlying logger.
-
isWarnEnabled
Tests whether warn messages are enabled.This allows expensive operations such as
Stringconcatenation to be avoided when the message will be ignored by the logger.- Specified by:
isWarnEnabledin interfaceLog- Returns:
- true if warn is enabled in the underlying logger.
-
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
-
setLevel
Sets logging level.- Parameters:
currentLogLevel- new logging level
-
trace
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE. -
trace
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE. -
warn
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN. -
warn
Logs a message withorg.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN. -
write
Writes the content of the message accumulated in the specifiedStringBufferto the appropriate output destination. The default implementation writes toSystem.err.- Parameters:
buffer- AStringBuffercontaining the accumulated text to be logged
-