| Package | uk.msfx.utils.tracing |
| Class | public class TrCore |
| Inheritance | TrCore  Object |
The core Class for managing and formatting the output for Tr.ace().
| Method | Defined By | ||
|---|---|---|---|
TrCore(lock:Class)
Constructor. | TrCore | ||
out(output:*, user:String, withinClass:*, startWithLineBreak:Boolean = false, endWithLineBreak:Boolean = false):void
Function to format and trace to the output console. | TrCore | ||
outArray(output:Array, user:String, withinClass:*, level:int = 0):void
Function to format and trace the contents of an Array to the console. | TrCore | ||
outMulti(values:Array, user:String, withinClass:*):void
Function to trace multiple values out, seperated by commas. | TrCore | ||
outObject(output:Object, user:String, withinClass:*, level:int = 0):void
Function to format and trace the contents of an Object to the console. | TrCore | ||
| TrCore | () | Constructor |
public function TrCore(lock:Class)Constructor.
This Class uses a Singleton design pattern, the SingletonLock Class is passed via the lock parameter to mimmick the Singleton design.
lock:Class — Class used to mimmick 'Singleton'
|
| out | () | method |
public function out(output:*, user:String, withinClass:*, startWithLineBreak:Boolean = false, endWithLineBreak:Boolean = false):voidFunction to format and trace to the output console.
The Tr.DEFAULT user will be used if no username is entered.
Parameters
output:* — The output that you wish to trace to the console
| |
user:String — The name of the user tracing the output
| |
withinClass:* — The name of the Class the output is being traced from
| |
startWithLineBreak:Boolean (default = false) | |
endWithLineBreak:Boolean (default = false) |
| outArray | () | method |
public function outArray(output:Array, user:String, withinClass:*, level:int = 0):voidFunction to format and trace the contents of an Array to the console.
The Tr.DEFAULT user will be used if no username is entered.
Parameters
output:Array — The Array that you wish to trace to the console
| |
user:String — The name of the user tracing the output
| |
withinClass:* — The name of the Class being traced from
| |
level:int (default = 0) |
| outMulti | () | method |
public function outMulti(values:Array, user:String, withinClass:*):voidFunction to trace multiple values out, seperated by commas.
Parameters
values:Array — Array of values to be traced out
| |
user:String | |
withinClass:* |
| outObject | () | method |
public function outObject(output:Object, user:String, withinClass:*, level:int = 0):voidFunction to format and trace the contents of an Object to the console.
The Tr.DEFAULT user will be used if no username is entered.
Parameters
output:Object — The Object that you wish to trace to the console
| |
user:String — The name of the user tracing the output
| |
withinClass:* — The name of the Class being traced from
| |
level:int (default = 0) |