public class SimpleLog extends Object implements Log, Serializable
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 to
true
if you want the Log instance name to be included in output
messages. Defaults to false
.org.apache.commons.logging.simplelog.showShortLogname
- Set
to true
if you want the last component of the name to be
included in output messages. Defaults to true
.org.apache.commons.logging.simplelog.showdatetime
- Set to
true
if you want the current date and time to be included in
output messages. Default is false
.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 in
java.text.SimpleDateFormat
. If the format is not specified or is
invalid, the default format is used. The default format is
yyyy/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).
Modifier and Type | Field and Description |
---|---|
protected int |
currentLogLevel
The current log level
|
protected static DateFormat |
dateFormatter
Used to format times
|
protected static String |
dateTimeFormat
The date and time format to use in the log message
|
protected static String |
DEFAULT_DATE_TIME_FORMAT
The default format to use when formating dates
|
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 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.
|
protected static Properties |
simpleLogProps
Properties loaded from simplelog.properties
|
protected static String |
systemPrefix
All system properties used by
SimpleLog start with this |
Constructor and Description |
---|
SimpleLog(String name)
Construct a simple log with given name.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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?
|
boolean |
isErrorEnabled()
Are error messages currently enabled?
|
boolean |
isFatalEnabled()
Are fatal messages currently enabled?
|
boolean |
isInfoEnabled()
Are info messages currently enabled?
|
protected boolean |
isLevelEnabled(int logLevel)
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,
Object message,
Throwable t)
Do the actual logging.
|
void |
setLevel(int currentLogLevel)
Set logging level.
|
void |
trace(Object message)
Log a message with trace log level.
|
void |
trace(Object message,
Throwable t)
Log an error with trace 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.
|
protected void |
write(StringBuffer buffer)
Write the content of the message accumulated in the specified
StringBuffer to the appropriate output destination. |
protected static final String systemPrefix
SimpleLog
start with thisprotected static final Properties simpleLogProps
protected static final String DEFAULT_DATE_TIME_FORMAT
protected static boolean showLogName
protected static boolean showShortName
protected static boolean showDateTime
protected static String dateTimeFormat
protected static DateFormat dateFormatter
public static final int LOG_LEVEL_TRACE
public static final int LOG_LEVEL_DEBUG
public static final int LOG_LEVEL_INFO
public static final int LOG_LEVEL_WARN
public static final int LOG_LEVEL_ERROR
public static final int LOG_LEVEL_FATAL
public static final int LOG_LEVEL_ALL
public static final int LOG_LEVEL_OFF
protected String logName
protected int currentLogLevel
public SimpleLog(String name)
name
- log namepublic void setLevel(int currentLogLevel)
Set logging level.
currentLogLevel
- new logging levelpublic int getLevel()
Get logging level.
protected void log(int type, Object message, Throwable t)
Do the actual logging. This method assembles the message and then calls
write()
to cause it to be written.
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 loggedprotected void write(StringBuffer buffer)
Write the content of the message accumulated in the specified
StringBuffer
to the appropriate output destination. The
default implementation writes to System.err
.
buffer
- A StringBuffer
containing the accumulated text to be
loggedprotected boolean isLevelEnabled(int logLevel)
logLevel
- is this level enabled?public final void debug(Object message)
Log a message with debug log level.
public final void trace(Object message)
Log a message with trace log level.
public final void info(Object message)
Log a message with info log level.
public final void warn(Object message)
Log a message with warn log level.
public final void error(Object message)
Log a message with error log level.
public final void fatal(Object message)
Log a message with fatal log level.
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.
isDebugEnabled
in interface Log
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.
isErrorEnabled
in interface Log
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.
isFatalEnabled
in interface Log
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.
isInfoEnabled
in interface Log
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.
isTraceEnabled
in interface Log
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.
isWarnEnabled
in interface Log
Copyright © 2018 JBoss by Red Hat. All rights reserved.