Logger
ActionStepLogger provides support for the ActionStep Debugger.
The actual logging is always made using the org.actionstep.ASDebugger.trace
method. No other output devices are supported. Use the SimpleLogger to be
able to add log handlers as you please which allows you to log to every device you
want.
Configure the ActionStep Debugger API as usually and just use this class in your application to log messages or objects. This enables you to switch between almost every available logging API without having to change the logs in your application but just the underlying configuration on startup.
public function ActionStepLogger(name:String)
Constructs a new ActionStepLogger instance.
The default log level is ALL. This means all messages regardless of
their level are logged.
The name is used as class name for the ASDebugger.trace method, if
the passed class name is null or undefined.
name | (optional) the name of this logger |
static public ALL:Numberstatic public DEBUG:Numberstatic public INFO:Numberstatic public WARNING:Numberstatic public ERROR:Numberstatic public FATAL:Numberstatic public NONE:Numberpublic 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 used as class name for the ASDebugger.trace method, if
the passed class name is null or undefined.
name | the new name of this logger |
public function setLevel(level:Number):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 isEnabled(level:Number):Boolean
Checks whether this logger is enabled for the passed-in level.
false will be returned if:
level. level is null or undefined.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.
true if debug messages are logged
isDebugEnabled() in org.as2lib.env.log.Logger
public function isInfoEnabled(Void):BooleanChecks if this logger is enabled for info level log messages.
true if info messages are logged
isInfoEnabled() in org.as2lib.env.log.Logger
public function isWarningEnabled(Void):BooleanChecks if this logger is enabled for warning level log messages.
true if warning messages are logged
isWarningEnabled() in org.as2lib.env.log.Logger
public function isErrorEnabled(Void):BooleanChecks if this logger is enabled for error level log messages.
true if error messages are logged
isErrorEnabled() in org.as2lib.env.log.Logger
public function isFatalEnabled(Void):BooleanChecks if this logger is enabled for fatal level log messages.
true if fatal messages are logged
isFatalEnabled() in org.as2lib.env.log.Logger
public function log(message, level:Number, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at the given level.
The message is only logged when this logger is enabled for the
passed-in level.
The message is always logged using ASDebugger.trace passing
at least the arguments message and level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
level | the specific level at which the message shall be logged
|
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
public function debug(message, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at debug level.
The message is only logged when the level is set to DEBUG or
a level above.
The message is always logged using ASDebugger.trace passing
at least the arguments message, the debug level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
debug() in org.as2lib.env.log.Logger
public function info(message, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at info level.
The message is only logged when the level is set to INFO or
a level above.
The message is always logged using ASDebugger.trace passing
at least the arguments message, the info level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
info() in org.as2lib.env.log.Logger
public function warning(message, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at warning level.
The message is only logged when the level is set to WARNING
or a level above.
The message is always logged using ASDebugger.trace passing
at least the arguments message, the warning level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
warning() in org.as2lib.env.log.Logger
public function error(message, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at error level.
The message is only logged when the level is set to ERROR or
a level above.
The message is always logged using ASDebugger.trace passing
at least the arguments message, the error level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
error() in org.as2lib.env.log.Logger
public function fatal(message, className:String, fileName:String, lineNumber:Number):Void
Logs the passed-in message at fatal level.
The message is only logged when the level is set to FATAL or
a level above.
The message is always logged using ASDebugger.trace passing
at least the arguments message, the fatal level and className,
fileName and lineNumber if specified.
If className is null or undefined, the name of this
logger is used instead.
message | the message object to log |
className | (optional) the name of the class that logs the message
|
fileName | (optional) the name of the file that declares the class |
lineNumber | (optional) the line number at which the logging call stands |
fatal() in org.as2lib.env.log.Logger