org.as2lib.core.BasicClass
+--org.as2lib.env.log.logger.AbstractLogger
+--org.as2lib.env.log.logger.SimpleLoggerConfigurableLogger
SimpleLogger is a simple implementation of the ConfigurableLogger
interface.
The basic methods to write the log messages are log, debug, info, warning and fatal.
The first thing to note is that you can log messages at different levels.
These levels are DEBUG, INFO, WARNING, ERROR
and FATAL. Depending on what level has been set only messages at a
given level are logged. The levels are organized in a hierarchical manner. That
means if you set the log level to ALL every messages is logged. If you
set it to ERROR only messages at ERROR and FATAL level
are logged and so on. It is also possible to define your own set of levels. You
can therefor use the isEnabled and log methods.
To do not waste unnecessary performance in constructing log messages that are not logged you can use the methods isEnabled, isDebugEnabled, isInfoEnabled, isWarningEnabled, isErrorEnabled and isFatalEnabled.
Note that the message does in neither case have to be a string. That means
you can pass-in messages and let the actual log handler decide how to produce a
string representation of the message. This is in most cases done by using the
toString method of the specific message. You can use this method to do
not lose performance in cases where the message is not logged.
The actaul log output is made by log handlers. To configure and
access the handlers of this logger you can use the methods addHandler,
removeHandler, removeAllHandlers and getAllHandlers.
There are a few pre-defined handlers for different output devices.
Take a look at the org.as2lib.env.log.handler package for these.
Example:
var logger:SimpleLogger = new SimpleLogger("mySimpleLogger");
// adds a trace handler that is responsible for making the output
logger.addHandler(new TraceHandler());
// checks if the output gets actually made
if (logger.isInfoEnabled()) {
// log the message at the info level
logger.info("This is an informative log message.");
}
This logger cannot be used with the LoggerHierarchy because it does
not offer hierarchy support. If you want to use your logger in a hierarchy use
the SimpleHierarchicalLogger instead.
new SimpleLogger()
public function SimpleLogger(name:String)
Constructs a new SimpleLogger instance.
The default log level is ALL. This means all messages regardless of
their level are logged.
The logger name is by default shown in the log message to identify
where the message came from.
name | (optional) the name of this logger |
public function getName(Void):StringReturns the name of this logger.
This method returns null if no name has been set via the
setName method nor on construction.
the name of this logger
public function setName(name:String):VoidSets the name of this logger.
The name is by default shown in the log message.
name | the new name of this logger |
public function setLevel(level:LogLevel):VoidSets the log level.
The log level determines which messages are logged and which are not.
A level of value null or undefined is interpreted as level
ALL which is also the default level.
level | the new log level |
public function getLevel(Void):LogLevelReturns the set level.
the set level
public function addHandler(handler:LogHandler):VoidAdds a new log handler.
Log handlers are used to actually log the messages. They determine what information to log and to which output device.
This method simply does nothing if the passed-in handler is null or
undefined.
handler | the new log handler to log messages |
public function removeHandler(handler:LogHandler):Void
Removes all occerrences of the passed-in log handler.
If the passed-in handler is null or undefined the
method invocation is simply ignored.
handler | the log handler to remove |
public function removeAllHandlers(Void):VoidRemoves all added log handlers.
removeAllHandlers() in org.as2lib.env.log.ConfigurableLogger
public function getAllHandlers(Void):ArrayReturns all handlers that were added to this logger.
If there are no added handlers an empty array is returned.
all added log handlers
public function isEnabled(level:LogLevel):Boolean
Checks whether this logger is enabled for the passed-in level.
false will be returned if:
level. level is null or undefined.Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
level | the level to make the check upon |
true if this logger is enabled for the given level else
false
public function isDebugEnabled(Void):BooleanChecks if this logger is enabled for debug level log messages.
Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
true if debug messages are logged
public function isInfoEnabled(Void):BooleanChecks if this logger is enabled for info level log messages.
Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
true if info messages are logged
public function isWarningEnabled(Void):BooleanChecks if this logger is enabled for warning level log messages.
Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
true if warning messages are logged
public function isErrorEnabled(Void):BooleanChecks if this logger is enabled for error level log messages.
Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
true if error messages are logged
public function isFatalEnabled(Void):BooleanChecks if this logger is enabled for fatal level log messages.
Using this method as shown in the class documentation may improve performance depending on how long the log message construction takes.
true if fatal messages are logged
public function log(message, level:LogLevel):Void
Logs the message at the given level.
The message is only logged when this logger is enabled for the
passed-in level.
message | the message object to log |
level | the specific level at which the message shall be logged
|
public function debug(message):Void
Logs the message object at debug level.
The message is only logged when the level is set to DEBUG or
a level above.
message | the message object to log |
public function info(message):Void
Logs the message object at info level.
The message gets only logged when the level is set to INFO
or a level above.
message | the message object to log |
public function warning(message):Void
Logs the message object at warning level.
The message gets only logged when the level is set to WARNING
or a level above.
message | the message object to log |