Packageorg.as3commons.logging.setup.target
Classpublic final class ArthropodTarget
InheritanceArthropodTarget Inheritance Object
Implements IFormattingLogTarget

Since : 2.5

Sends log statements to the Athropod Logging client.

See also

http://arthropod.stopp.se


Public Properties
 PropertyDefined By
  colors : Object
[write-only]
ArthropodTarget
  format : String
[write-only] Defines the format used by the target to transform the log statement to a string.
ArthropodTarget
  warnLevels : LogSetupLevel
[write-only] Athropod supports log and warn statements.
ArthropodTarget
Public Methods
 MethodDefined By
  
ArthropodTarget(format:String = null, colors:Object = null, warnLevels:LogSetupLevel = null)
Creates a new Arthopod log target.
ArthropodTarget
  
log(name:String, shortName:String, level:int, timeStamp:Number, message:*, parameters:Array, person:String):void
Renders a log statement.
ArthropodTarget
Public Constants
 ConstantDefined By
  DEFAULT_COLORS : Object
[static] Default colors used to color the output statements.
ArthropodTarget
  DEFAULT_FORMAT : String = {shortName}{atPerson} {message}
[static] Default format used to log statements
ArthropodTarget
Property Detail
colorsproperty
colors:Object  [write-only]


Implementation
    public function set colors(value:Object):void
formatproperty 
format:String  [write-only]

Defines the format used by the target to transform the log statement to a string.

The format passed in can use any of the the following definitions:

FieldDescription
{date}The date in the format YYYY/MM/DD
{dateUTC}The UTC date in the format YYYY/MM/DD
{gmt}The time offset of the statement to the Greenwich mean time in the format GMT+9999
{logLevel}The level of the log statement (example: DEBUG )
{logTime}The UTC time in the format HH:MM:SS.0MS
{message}The message of the logger
{message_dqt}The message of the logger, double quote escaped.
{name}The name of the logger
{time}The time in the format H:M:S.MS
{timeUTC}The UTC time in the format H:M:S.MS
{shortName}The short name of the logger
{shortSWF}The SWF file name
{swf}The full SWF path
{person}The Person that wrote this statement
{atPerson}The Person that wrote this statement with the 'at' prefix


Implementation
    public function set format(value:String):void
warnLevelsproperty 
warnLevels:LogSetupLevel  [write-only]

Athropod supports log and warn statements. With this property you can define which levels should use the warn statement and which should use the log statements.


Implementation
    public function set warnLevels(value:LogSetupLevel):void
Constructor Detail
ArthropodTarget()Constructor
public function ArthropodTarget(format:String = null, colors:Object = null, warnLevels:LogSetupLevel = null)

Creates a new Arthopod log target.

Parameters
format:String (default = null) — Default format to for the logging, if null, it will use the DEFAULT_FORMAT.
 
colors:Object (default = null) — Colors used to display the different log statements (default=DEFAULT_COLORS)
 
warnLevels:LogSetupLevel (default = null) — Levels that use the warn method instead of the log method (default=WARN_ONLY);
Method Detail
log()method
public function log(name:String, shortName:String, level:int, timeStamp:Number, message:*, parameters:Array, person:String):void

Renders a log statement.

In version 2.5 the person information was added and the time stamp was modified to represent the local time rather than the time in gmt. Add START_TIME to get the time in ms since 1970.

Parameters

name:String — Name of the logger that triggered the log statement.
 
shortName:String — Shortened form of the name.
 
level:int — Level of the log statement that got triggered.
 
timeStamp:Number — getTimer() Timestame of when the log statement was triggered.
 
message:* — Message of the log statement.
 
parameters:Array — Parameters for the log statement.
 
person:String — Information about the person that filed this log statement.

Constant Detail
DEFAULT_COLORSConstant
public static const DEFAULT_COLORS:Object

Default colors used to color the output statements.

DEFAULT_FORMATConstant 
public static const DEFAULT_FORMAT:String = {shortName}{atPerson} {message}

Default format used to log statements