Public Properties
 PropertyDefined By
  SWF_SHORT_URL : String = [SWF url not initialized. Please call SWFInfo.init(stage).]
The URL of the currently running SWF in its short form (just the file name).
org.as3commons.logging.util
  SWF_URL : String = [SWF url not initialized. Please call SWFInfo.init(stage).]
The URL of the currently running SWF.
org.as3commons.logging.util


Public Methods
 FunctionDefined By
  
allProperties(value:*):Array
Returns a array with all public accessible properties of a object.
org.as3commons.logging.util
  
captureUncaughtErrors(loaderInfo:LoaderInfo):void
Util that redirects the uncaught global errors to the log as fatal messages.
org.as3commons.logging.util
  
clone(object:*, introspectDepth:uint = 4.294967295E9, storage:Dictionary = null, useByteArray:Boolean = true):*
Copies/Clones any generic object.
org.as3commons.logging.util
  
flatten(arr:Array):void
Flattens a tree of arrays to one array.
org.as3commons.logging.util
  
here(linesChopped:int = 0, useLineNumbers:Boolean = true):String
Extracts the current method name/linenumber from the calling position if possible.
org.as3commons.logging.util
  
instantiate(type:Class, args:Array = null):*
Util to instantiate classes.
org.as3commons.logging.util
  
jsonXify(object:*, levels:int = 5):String
Creates a json string from a given object.
org.as3commons.logging.util
  
levelToName(level:int):String
Returns the name for a level as String.
org.as3commons.logging.util
  
locationFromStackTrace(stackTrace:String, lineNo:int = 0, useLineNumbers:Boolean = true):String
Parses one location from the given stacktrace and gives it in a logging compatible format.
org.as3commons.logging.util
  
logRuntimeInfo(stage:Stage, base:DisplayObject = null):void
Logs as much informations about the current runtime as it can get.
org.as3commons.logging.util
  
objectify(value:*, map:Dictionary = null, levels:uint = 5):*
Introspects a object, makes it js transferable and returns it.
org.as3commons.logging.util
  
passToFactory(statements:Array, factory:LoggerFactory = null):void
Logs a list of log statements to a factory.
org.as3commons.logging.util
  
passToTarget(statements:Array, logTarget:ILogTarget):void
Logs a list of log statements to a log target.
org.as3commons.logging.util
  
regExpFromString(string:String):RegExp
Transforms a string that contains regular regexp syntax to a working RegExp instance.
org.as3commons.logging.util
  
removeDuplicates(arr:Array):void
Removes duplicates in an array.
org.as3commons.logging.util
  
toLogName(input:* = null):String
Transforms a input class or object to a viable logger name.
org.as3commons.logging.util


Public Constants
 ConstantDefined By
  GMT : String
GMT offset of the running swf.
org.as3commons.logging.util
  IS_DEBUGGER : Boolean
High performance access to "Capabilities.isDebugger" (roughly 15times faster)
org.as3commons.logging.util
  LEVEL_NAMES : Object
High speed access to the common names for levels (also used by levelToName)
org.as3commons.logging.util
  START_TIME : Number
Time when this swf started in ms since 1970.
org.as3commons.logging.util
  URL_ERROR : String = [SWF url not initialized. Please call SWFInfo.init(stage).]
Default errors for the URL variables.
org.as3commons.logging.util
Constant Detail
GMTConstant
public const GMT:String

Since : 2.5

GMT offset of the running swf.

IS_DEBUGGERConstant 
public const IS_DEBUGGER:Boolean

Since : 2.6

High performance access to "Capabilities.isDebugger" (roughly 15times faster)

LEVEL_NAMESConstant 
public const LEVEL_NAMES:Object

Since : 2.5.2

High speed access to the common names for levels (also used by levelToName)

See also

org.as3commons.logging.util.levelToName()
START_TIMEConstant 
public const START_TIME:Number

Since : 2.5

Time when this swf started in ms since 1970.

URL_ERRORConstant 
public const URL_ERROR:String = [SWF url not initialized. Please call SWFInfo.init(stage).]

Default errors for the URL variables.

Function detail
allProperties()function
public function allProperties(value:*):Array

Since : 2.5

Returns a array with all public accessible properties of a object.

Parameters

value:* — Value of which all properties should be evaluated

Returns
Array
captureUncaughtErrors()function 
public function captureUncaughtErrors(loaderInfo:LoaderInfo):void

Since : 2.5

Util that redirects the uncaught global errors to the log as fatal messages.

Parameters

loaderInfo:LoaderInfo — LoaderInfo, preferrably of the root DisplayObject

clone()function 
public function clone(object:*, introspectDepth:uint = 4.294967295E9, storage:Dictionary = null, useByteArray:Boolean = true):*

Since : 2.5

Copies/Clones any generic object.

If the object has a clone or copy method it will be used to copy the object, else it will attempt to copy it using a bytearray.

Primitive objects, namely String, Number, Boolean, Function, Namespace, QName instances can not be copied anywhere are simply returned.

Parameters

object:* — Object to be cloned
 
introspectDepth:uint (default = 4.294967295E9) — Storage of all the instances created (not necessary to be passed)
 
storage:Dictionary (default = null) — True It will try copy using a bytearray (and preserving the type) or just copy the objects to primitive objects.
 
useByteArray:Boolean (default = true) — depth to which the objects should be introspected in case it cant be copied using a bytearray, copy or clone.

Returns
* — Clone of the object
flatten()function 
public function flatten(arr:Array):void

Since : 2.6

Flattens a tree of arrays to one array.

Parameters

arr:Array — Array to flatten out

here()function 
public function here(linesChopped:int = 0, useLineNumbers:Boolean = true):String

Since : 2.5

Extracts the current method name/linenumber from the calling position if possible.

In the release player it is not possible to retreive the current location.

Note: It is just with the debug player possible to get the current target, see: Bug FP-644 in the adobe bug base.

Warning: Performance intense task, use with care!

Parameters

linesChopped:int (default = 0) — Amount of lines in the stacktrace that should be cut.
 
useLineNumbers:Boolean (default = true) — If true the line numbers will not be cropped

Returns
String — The current location (if evaluatable)

See also

https://bugs.adobe.com/jira/browse/FP-644
org.as3commons.logging.util.locationFromStackTrace()
instantiate()function 
public function instantiate(type:Class, args:Array = null):*

Since : 2.7

Util to instantiate classes.

Parameters

type:Class — Class to be instantiated
 
args:Array (default = null) — Constructor arguments used

Returns
* — New instance of the class
jsonXify()function 
public function jsonXify(object:*, levels:int = 5):String

Since : 2.5

Creates a json string from a given object.

We are using a extended json fromat that uses references, much alike the dojo format.

Parameters

object:*
 
levels:int (default = 5)

Returns
String

See also

http://www.sitepen.com/blog/2008/06/17/json-referencing-in-dojo/
http://dojotoolkit.org/reference-guide/dojox/json/ref.html
http://dojotoolkit.org/api/1.5/dojox/json/ref
levelToName()function 
public function levelToName(level:int):String

Since : 2.5

Returns the name for a level as String.

Parameters

level:int — Level as integer

Returns
String
locationFromStackTrace()function 
public function locationFromStackTrace(stackTrace:String, lineNo:int = 0, useLineNumbers:Boolean = true):String

Since : 2.6

Parses one location from the given stacktrace and gives it in a logging compatible format.

Parameters

stackTrace:String — StackTrace to parse
 
lineNo:int (default = 0) — Line number to use
 
useLineNumbers:Boolean (default = true) — Show the line number from the log statement

Returns
String

See also

org.as3commons.logging.util.here()
logRuntimeInfo()function 
public function logRuntimeInfo(stage:Stage, base:DisplayObject = null):void

Since : 2.5

Logs as much informations about the current runtime as it can get.

Parameters

stage:Stage — State to take the information that should be displayed.
 
base:DisplayObject (default = null) — DisplayObject to be used for scriptVersion and actionScriptVersion evaluation

objectify()function 
public function objectify(value:*, map:Dictionary = null, levels:uint = 5):*

Since : 2.5

Introspects a object, makes it js transferable and returns it.

Parameters

value:* — any object
 
map:Dictionary (default = null)
 
levels:uint (default = 5)

Returns
* — js valid representation
passToFactory()function 
public function passToFactory(statements:Array, factory:LoggerFactory = null):void

Since : 2.5

Logs a list of log statements to a factory.

Parameters

statements:Array — Array of log statements (first=oldest, last=newest);
 
factory:LoggerFactory (default = null) — LoggerFactory to flush to. LOGGER_FACTORY will be used if null is passed-in.

passToTarget()function 
public function passToTarget(statements:Array, logTarget:ILogTarget):void

Since : 2.5

Logs a list of log statements to a log target.

Parameters

statements:Array — Array of log statements (first=oldest, last=newest);
 
logTarget:ILogTarget — ILogTarget to flush to.

regExpFromString()function 
public function regExpFromString(string:String):RegExp

Since : 2.6

Transforms a string that contains regular regexp syntax to a working RegExp instance. 

     var a: RegExp = regExpFromString("/test/i");
     a.ignoreCase; // true
     a.source; // "test"

Parameters

string:String — String to be transformed to Regular Expression

Returns
RegExp — RegExp instance if its a valid expression, else "null"
removeDuplicates()function 
public function removeDuplicates(arr:Array):void

Since : 2.6

Removes duplicates in an array.

Parameters

arr:Array — Array to remove the duplicates from.

toLogName()function 
public function toLogName(input:* = null):String

Transforms a input class or object to a viable logger name.

Parameters

input:* (default = null) — Class or object from which the class name will be taken from

Returns
String — Classname prepared to be used within the logging framework.
Property Detail
SWF_SHORT_URLproperty
public var SWF_SHORT_URL:String = [SWF url not initialized. Please call SWFInfo.init(stage).]

The URL of the currently running SWF in its short form (just the file name).

See also

org.as3commons.logging.util.SWFInfo.init()
SWF_URLproperty 
public var SWF_URL:String = [SWF url not initialized. Please call SWFInfo.init(stage).]

Since : 2.0

The URL of the currently running SWF.

See also

org.as3commons.logging.util.SWFInfo.init()


Fri Oct 14 2011, 02:24 PM +02:00