Class org.as2lib.env.log.logger.ActionStepLogger

org.as2lib.core.BasicClass
   +--org.as2lib.env.log.logger.ActionStepLogger

Implemented Interfaces

Logger

Description

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.

Field Index

ALL, DEBUG, ERROR, FATAL, INFO, NONE, WARNING

Method Index

new ActionStepLogger()

debug(), error(), fatal(), getLevel(), getName(), info(), isDebugEnabled(), isEnabled(), isErrorEnabled(), isFatalEnabled(), isInfoEnabled(), isWarningEnabled(), log(), setLevel(), setName(), warning()

Inherited from BasicClass

toString()

Constructor Detail

ActionStepLogger

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.

Parameters

name(optional) the name of this logger

Field Detail

ALL

static public ALL:Number
All level.

DEBUG

static public DEBUG:Number
ActionStep debug level.

INFO

static public INFO:Number
ActionStep info level.

WARNING

static public WARNING:Number
ActionStep warning level.

ERROR

static public ERROR:Number
ActionStep error level.

FATAL

static public FATAL:Number
ActionStep fatal level.

NONE

static public NONE:Number
None level.

Method Detail

getName

public function getName(Void):String

Returns the name of this logger.

This method returns null if no name has been set via the setName method nor on construction.

Return

the name of this logger

setName

public function setName(name:String):Void

Sets 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.

Parameters

namethe new name of this logger

setLevel

public function setLevel(level:Number):Void

Sets 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.

Parameters

levelthe new log level

getLevel

public function getLevel(Void):Number

Returns the set level.

Return

the set level

isEnabled

public function isEnabled(level:Number):Boolean

Checks whether this logger is enabled for the passed-in level.

false will be returned if:

  • This logger is not enabled for the passed-in level.
  • The passed-in level is null or undefined.

Parameters

levelthe level to make the check upon

Return

true if this logger is enabled for the given level else false

isDebugEnabled

public function isDebugEnabled(Void):Boolean

Checks if this logger is enabled for debug level log messages.

Return

true if debug messages are logged

Specified By

isDebugEnabled() in org.as2lib.env.log.Logger

isInfoEnabled

public function isInfoEnabled(Void):Boolean

Checks if this logger is enabled for info level log messages.

Return

true if info messages are logged

Specified By

isInfoEnabled() in org.as2lib.env.log.Logger

isWarningEnabled

public function isWarningEnabled(Void):Boolean

Checks if this logger is enabled for warning level log messages.

Return

true if warning messages are logged

Specified By

isWarningEnabled() in org.as2lib.env.log.Logger

isErrorEnabled

public function isErrorEnabled(Void):Boolean

Checks if this logger is enabled for error level log messages.

Return

true if error messages are logged

Specified By

isErrorEnabled() in org.as2lib.env.log.Logger

isFatalEnabled

public function isFatalEnabled(Void):Boolean

Checks if this logger is enabled for fatal level log messages.

Return

true if fatal messages are logged

Specified By

isFatalEnabled() in org.as2lib.env.log.Logger

log

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.

Parameters

messagethe message object to log
levelthe 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

debug

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.

Parameters

messagethe 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

Specified By

debug() in org.as2lib.env.log.Logger

info

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.

Parameters

messagethe 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

Specified By

info() in org.as2lib.env.log.Logger

warning

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.

Parameters

messagethe 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

Specified By

warning() in org.as2lib.env.log.Logger

error

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.

Parameters

messagethe 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

Specified By

error() in org.as2lib.env.log.Logger

fatal

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.

Parameters

messagethe 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

Specified By

fatal() in org.as2lib.env.log.Logger

as2api