Public Properties
 PropertyDefined By
  USE_LINE_NUMBERS : Boolean = true
If set to true true it will show the line numbers for the log statements.
org.as3commons.logging.simple
  USE_STACKTRACE : Boolean = false
If set to true, the simple api will try to evaluate the logger using the stacktrace.
org.as3commons.logging.simple


Public Methods
 FunctionDefined By
  
aTrace(... args):void
Subsitute for the native trace function.
org.as3commons.logging.simple
  
debug(message:*, parameters:Array = null):void
Logs a message for debug purposes to the DIRECT_LOGGER Debug messages should be messages that are additional output used to ease the debugging of an application. A message can contain place holders that are filled with the additional parameters.
org.as3commons.logging.simple
  
error(message:*, parameters:Array = null):void
Logs a message to notify about an error that was dodged by the application to the DIRECT_LOGGER The Error level is designated to be used in case an error occurred and the error could be dodged.
org.as3commons.logging.simple
  
fatal(message:*, parameters:Array = null):void
Logs a message to notify about an error that broke the application and couldn't be fixed automatically to the DIRECT_LOGGER.
org.as3commons.logging.simple
  
info(message:*, parameters:Array = null):void
Logs a message for notification purposes to the DIRECT_LOGGER.
org.as3commons.logging.simple
  
isDebugEnabled():Boolean
true if debug actually does something.
org.as3commons.logging.simple
  
isErrorEnabled():Boolean
true if error actually does something.
org.as3commons.logging.simple
  
isFatalEnabled():Boolean
true if fatal actually does something.
org.as3commons.logging.simple
  
isInfoEnabled():Boolean
true if info actually does something.
org.as3commons.logging.simple
  
isWarnEnabled():Boolean
true if warn actually does something.
org.as3commons.logging.simple
  
warn(message:*, parameters:Array = null):void
Logs a message for warning about a undesirable application state to the DIRECT_LOGGER.
org.as3commons.logging.simple


Public Constants
 ConstantDefined By
  DIRECT_LOGGER : ILogger
Default instance used in this package to log statements.
org.as3commons.logging.simple
Constant Detail
DIRECT_LOGGERConstant
public const DIRECT_LOGGER:ILogger

Since : 2.5

Default instance used in this package to log statements.

Function detail
aTrace()function
public function aTrace(... args):void

Subsitute for the native trace function.

In many applications the classic trace is used to trace statements. To refactor this code one can use this function in a search&replace for the trace statements and have immediatly a as3commons logger.

Parameters

... args

debug()function 
public function debug(message:*, parameters:Array = null):void

Since : 2.5

Logs a message for debug purposes to the DIRECT_LOGGER

Debug messages should be messages that are additional output used to ease the debugging of an application.

A message can contain place holders that are filled with the additional parameters. The ILogTarget implementation may treat the options as they want.

Example for a message with parameters:

       error("A: {0} is B: {1}", "Hello", "World");
       // A: Hello is B: World
     

Parameters

message:* — Message that should be logged.
 
parameters:Array (default = null) — List of parameters.

error()function 
public function error(message:*, parameters:Array = null):void

Since : 2.5

Logs a message to notify about an error that was dodged by the application to the DIRECT_LOGGER

The Error level is designated to be used in case an error occurred and the error could be dodged. It should contain hints about why that error occurs and if there is a common case where this error occurs.

A message can contain place holders that are filled with the additional parameters. The ILogTarget implementation may treat the options as they want.

Example for a message with parameters:

       error("A: {0} is B: {1}", "Hello", "World");
       // A: Hello is B: World
     

Parameters

message:* — Message that should be logged.
 
parameters:Array (default = null) — List of parameters.

fatal()function 
public function fatal(message:*, parameters:Array = null):void

Logs a message to notify about an error that broke the application and couldn't be fixed automatically to the DIRECT_LOGGER.

The Fatal level is designated to be used in case an error occurred that couldn't be stopped. A fatal error usually results in a inconsistent or inperceivable application state.

A message can contain place holders that are filled with the additional parameters. The ILogTarget implementation may treat the options as they want.

Example for a message with parameters:

       fatal("A: {0} is B: {1}", "Hello", "World");
       // A: Hello is B: World
     

Parameters

message:* — Message that should be logged.
 
parameters:Array (default = null) — List of parameters.

info()function 
public function info(message:*, parameters:Array = null):void

Logs a message for notification purposes to the DIRECT_LOGGER.

Notification messages should be messages that highlight interesting informations about what happens in the the application.

A message can contain place holders that are filled with the additional parameters. The ILogTarget implementation may treat the options as they want.

Example for a message with parameters:

       info("A: {0} is B: {1}", "Hello", "World");
       // A: Hello is B: World
     

Parameters

message:* — Message that should be logged.
 
parameters:Array (default = null) — List of parameters.

isDebugEnabled()function 
public function isDebugEnabled():Boolean

Since : 2.5

true if debug actually does something.

Returns
Boolean

See also

isErrorEnabled()function 
public function isErrorEnabled():Boolean

Since : 2.5

true if error actually does something.

Returns
Boolean

See also

isFatalEnabled()function 
public function isFatalEnabled():Boolean

Since : 2.5

true if fatal actually does something.

Returns
Boolean

See also

isInfoEnabled()function 
public function isInfoEnabled():Boolean

Since : 2.5

true if info actually does something.

Returns
Boolean

See also

isWarnEnabled()function 
public function isWarnEnabled():Boolean

Since : 2.5

true if warn actually does something.

Returns
Boolean

See also

warn()function 
public function warn(message:*, parameters:Array = null):void

Logs a message for warning about a undesirable application state to the DIRECT_LOGGER.

Warnings are designated to be used in case code got executed that is not desirable for performance, memory or clarity reasons but didn't result in any error.

A message can contain place holders that are filled with the additional parameters. The ILogTarget implementation may treat the options as they want.

Example for a message with parameters:

       warn("A: {0} is B: {1}", "Hello", "World");
       // A: Hello is B: World
     

Parameters

message:* — Message that should be logged.
 
parameters:Array (default = null) — List of parameters.

Property Detail
USE_LINE_NUMBERSproperty
public var USE_LINE_NUMBERS:Boolean = true

Since : 2.6

If set to true true it will show the line numbers for the log statements.

This switch is available for the case one has too many logging calls and the flash player gets unbearable slow. In that particular case USE_LINE_NUMBERS will reduce at least the amount of loggers instantiated. (not one per line but one per method. This setting is only effective if the swf is compiled for debugging and it runs in a debug player.

USE_STACKTRACEproperty 
public var USE_STACKTRACE:Boolean = false

Since : 2.6

If set to true, the simple api will try to evaluate the logger using the stacktrace.

This is a very performance intense property. If you use it your application might slow down a lot!

The stacktrace is just available if you run the resulting .swf in a Flash Debug Player.

See also