Packagecom.adobe.rtc.util
Classpublic class DebugUtil

Utility class for debugging.



Public Properties
 PropertyDefined by
  suppressDebugTraces : Boolean = false
[static] A flag to turn on/off tracing.
DebugUtil
  traceFunction : Function
[static] A custom trace function that can be defined by the developer.
DebugUtil
Public Methods
 MethodDefined by
  
debugTrace(p_traceString:String):void
[static] A custom log function that can be turned on/off using the suppressDebugTraces.
DebugUtil
  
dumpObject(p_name:String, p_obj:Object, ... rest):void
[static] Takes an object and traces its content and the type of each member in a tree form.
DebugUtil
  
dumpObjectShallow(p_name:String, p_obj:Object, ... rest):void
[static] Similar to dumpObject() but it's not recursive, and it only traces the first level of the object that's passed in.
DebugUtil
Property detail
suppressDebugTracesproperty
public static var suppressDebugTraces:Boolean = false

A flag to turn on/off tracing. The flag is used in conjunction with the debugTrace method. The traces are turned off if true.

The default value is false.

traceFunctionproperty 
public static var traceFunction:Function

A custom trace function that can be defined by the developer. It can turned on and off using the suppressDebugTraces.

Method detail
debugTrace()method
public static function debugTrace(p_traceString:String):void

A custom log function that can be turned on/off using the suppressDebugTraces. The traces are outputted only when suppressDebugTraces is false. The default trace() function is used if the traceFunction is not defined.

Parameters
p_traceString:String
dumpObject()method 
public static function dumpObject(p_name:String, p_obj:Object, ... rest):void

Takes an object and traces its content and the type of each member in a tree form. In additional to the two standard parameters, two optional parameters may be passed in:

Parameters
p_name:String — The name of the object.
 
p_obj:Object — The object to trace.
 
... rest
dumpObjectShallow()method 
public static function dumpObjectShallow(p_name:String, p_obj:Object, ... rest):void

Similar to dumpObject() but it's not recursive, and it only traces the first level of the object that's passed in. In additional to the two standard parameters, two optional parameters may be passed in:

Parameters
p_name:String — The name of the object.
 
p_obj:Object — The object to trace.
 
... rest




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/util/DebugUtil.html