Packagecom.bourre.plugin
Classpublic class PluginDebug
ImplementsLog

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The PluginDebug class defines "logging tunnel" for plugin logging feature.

Each Plugin has his unique logging tunnel to log message throw LowRA Logging API.


Public Properties
 PropertyDefined by
  isOn : Boolean = true
[static] Channel is open or not.
PluginDebug
Protected Properties
 PropertyDefined by
  _channel : EventChannel
Event channel for this log target.
PluginDebug
  _owner : Plugin
Plugin owner.
PluginDebug
Public Methods
 MethodDefined by
  
debug(o:*):void
Logs passed-in message with a log level defined at 'debug' mode.
PluginDebug
  
error(o:*):void
Logs passed-in message with a log level defined at 'error' mode.
PluginDebug
  
fatal(o:*):void
Logs passed-in message with a log level defined at 'fatal' mode.
PluginDebug
  
getChannel():EventChannel
Returns event channel used for communication.
PluginDebug
  
getInstance(owner:Plugin = null):PluginDebug
[static] Returns PluginDebug for passed-in plugin.
PluginDebug
  
getOwner():Plugin
Returns plugin owner.
PluginDebug
  
info(o:*):void
Logs passed-in message with a log level defined at 'info' mode.
PluginDebug
  
isOn():Boolean
Returns true if logging tunnel is opened.
PluginDebug
  
off():void
Closes the logging tunnel.
PluginDebug
  
on():void
Opens the logging tunnel.
PluginDebug
  
release(owner:Plugin):Boolean
[static] Releases PluginDebug instance for passed-in plugin.
PluginDebug
  
toString():String
Returns the string representation of this instance.
PluginDebug
  
warn(o:*):void
Logs passed-in message with a log level defined at 'warn' mode.
PluginDebug
Property detail
_channelproperty
protected var _channel:EventChannel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Event channel for this log target.

isOnproperty 
public static var isOn:Boolean = true

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Channel is open or not.

The default value is true.

_ownerproperty 
protected var _owner:Plugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Plugin owner.

Method detail
debug()method
public function debug(o:*):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in message with a log level defined at 'debug' mode.

Parameters
o:*
error()method 
public function error(o:*):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in message with a log level defined at 'error' mode.

Parameters
o:*
fatal()method 
public function fatal(o:*):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in message with a log level defined at 'fatal' mode.

Parameters
o:*
getChannel()method 
public function getChannel():EventChannel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns event channel used for communication.

Returns
EventChannel
getInstance()method 
public static function getInstance(owner:Plugin = null):PluginDebug

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns PluginDebug for passed-in plugin.

If PluginDebug is not created, creates it.

If owner is null, use the NullPlugin instance. Parameters

owner:Plugin (default = null) — Target plugin

Returns
PluginDebug — The PluginDebug for passed-in plugin
getOwner()method 
public function getOwner():Plugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns plugin owner.

Returns
Plugin
info()method 
public function info(o:*):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in message with a log level defined at 'info' mode.

Parameters
o:*
isOn()method 
public function isOn():Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if logging tunnel is opened.

Returns
Boolean
off()method 
public function off():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Closes the logging tunnel.

on()method 
public function on():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Opens the logging tunnel.

release()method 
public static function release(owner:Plugin):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Releases PluginDebug instance for passed-in plugin.

Parameters
owner:Plugin — Target plugin

Returns
Boolean
toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the string representation of this instance.

Returns
String — the string representation of this instance
warn()method 
public function warn(o:*):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in message with a log level defined at 'warn' mode.

Parameters
o:*



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00