| Package | org.as3commons.logging.setup.target |
| Class | public final class ArthropodTarget |
| Inheritance | ArthropodTarget Object |
| Implements | IFormattingLogTarget |
| Since : | 2.5 |
Athropod Logging client.
See also
| Property | Defined 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 | ||
| Method | Defined 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 | ||
| Constant | Defined 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 | ||
| colors | property |
colors:Object [write-only]
public function set colors(value:Object):void| format | property |
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:
| Field | Description |
|---|---|
| {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 |
public function set format(value:String):void| warnLevels | property |
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.
public function set warnLevels(value:LogSetupLevel):void| ArthropodTarget | () | Constructor |
public function ArthropodTarget(format:String = null, colors:Object = null, warnLevels:LogSetupLevel = null)
Creates a new Arthopod log target.
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);
|
| log | () | method |
public function log(name:String, shortName:String, level:int, timeStamp:Number, message:*, parameters:Array, person:String):voidRenders 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.
|
| DEFAULT_COLORS | Constant |
public static const DEFAULT_COLORS:ObjectDefault colors used to color the output statements.
| DEFAULT_FORMAT | Constant |
public static const DEFAULT_FORMAT:String = {shortName}{atPerson} {message}Default format used to log statements