Packagecom.bourre.log
Classpublic class Logger

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The Logger class allow to dispatch log message tl all registered Log listeners, in dedicated, or all logging channel.

Log level can be also apply to filter logging message.


Example 
  
  //filter level
  Logger.getInstance().setLevel( LogLevel.INFO );
  
  //Add log listener
  Logget.getInstance().addLogListener( SOSLayout.getIntance() );
  
  Logger.INFO( "this is a information message" ); //sent to all listeners
  Logger.DEBUG( "this is a debug message" ); //Not sent cause of level filter

See also

LogListener

Public Methods
 MethodDefined by
  
addLogListener(listener:LogListener, oChannel:EventChannel = null):void
Adds an event listener for the specified event type of the specified channel.
Logger
  
DEBUG(o:*, oChannel:EventChannel = null):Boolean
[static] Logs passed-in o message into oChannel logging channel using LogLevel.DEBUG level filter.
Logger
  
ERROR(o:*, oChannel:EventChannel = null):Boolean
[static] Logs passed-in o message into oChannel logging channel using LogLevel.ERROR level filter.
Logger
  
FATAL(o:*, oChannel:EventChannel = null):Boolean
[static] Logs passed-in o message into oChannel logging channel using LogLevel.FATAL level filter.
Logger
  
getInstance():Logger
[static] Returns unique Logger instance.
Logger
  
getLevel():LogLevel
Returns current LogLevel filter used.
Logger
  
hasListener(oChannel:EventChannel = null):Boolean
Returns true if there is a Broadcaster instance registered for the passed-in channel, and if this broadcaster has registered listeners.
Logger
  
INFO(o:*, oChannel:EventChannel = null):Boolean
[static] Logs passed-in o message into oChannel logging channel using LogLevel.INFO level filter.
Logger
  
isRegistered(listener:LogListener, oChannel:EventChannel):Boolean
Returns true if the passed-in listener is registered as listener for the passed-in event type in the passed-in channel.
Logger
  
log(e:LogEvent, oChannel:EventChannel = null):Boolean
Braodcasts passed-in e LogEvent in oChannel channel.
Logger
  
LOG(o:*, level:LogLevel, oChannel:EventChannel = null):Boolean
[static]
Logger
  
removeAllListeners():void
Removes all listeners object from this event channel broadcaster.
Logger
  
removeLogListener(listener:LogListener, oChannel:EventChannel = null):void
Removes the passed-in listener for listening the specified event of the specified channel.
Logger
  
setLevel(level:LogLevel):void
Sets logging level.
Logger
  
toString():String
Returns the string representation of this instance.
Logger
  
WARN(o:*, oChannel:EventChannel = null):Boolean
[static] Logs passed-in o message into oChannel logging channel using LogLevel.WARN level filter.
Logger
Events
 EventSummaryDefined by
  
onLog
Dispatched when a log message is sent.Logger
Method detail
addLogListener()method
public function addLogListener(listener:LogListener, oChannel:EventChannel = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds an event listener for the specified event type of the specified channel. There is two behaviors for the addEventListener function :

  1. The passed-in listener is an object : The object is added as listener only for the specified event, the object must have a function with the same name than type or at least a handleEvent function.
  2. The passed-in listener is a function : A Delegate object is created and then added as listener for the event type . There is no restriction on the name of the function.

Parameters
listener:LogListener — type name of the event for which register the listener
 
oChannel:EventChannel (default = null) — listener object or function which will receive this event

Throws
— UnsupportedOperationException — If the listener is an object which have neither a function with the same name than the event type nor a function called handleEvent

See also

DEBUG()method 
public static function DEBUG(o:*, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in o message into oChannel logging channel using LogLevel.DEBUG level filter.

Parameters
o:* — Message to log
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )
ERROR()method 
public static function ERROR(o:*, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in o message into oChannel logging channel using LogLevel.ERROR level filter.

Parameters
o:* — Message to log
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )
FATAL()method 
public static function FATAL(o:*, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in o message into oChannel logging channel using LogLevel.FATAL level filter.

Parameters
o:* — Message to log
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )
getInstance()method 
public static function getInstance():Logger

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns unique Logger instance.

Returns
Logger — Unique Logger instance.
getLevel()method 
public function getLevel():LogLevel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns current LogLevel filter used.

Returns
LogLevel — Current LogLevel filter used.
hasListener()method 
public function hasListener(oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if there is a Broadcaster instance registered for the passed-in channel, and if this broadcaster has registered listeners.

Parameters
oChannel:EventChannel (default = null) — event type to look at

Returns
Boolean — true if there is a Broadcaster instance registered for the passed-in channel, and if this broadcaster has registered listeners
INFO()method 
public static function INFO(o:*, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in o message into oChannel logging channel using LogLevel.INFO level filter.

Parameters
o:* — Message to log
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )
isRegistered()method 
public function isRegistered(listener:LogListener, oChannel:EventChannel):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if the passed-in listener is registered as listener for the passed-in event type in the passed-in channel.

Parameters
listener:LogListener — LogListener to look for registration
 
oChannel:EventChannel — event type to look at

Returns
Boolean — true if the passed-in listener is registered as listener for the passed-in event type in the passed-in channel

See also

log()method 
public function log(e:LogEvent, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Braodcasts passed-in e LogEvent in oChannel channel.

Parameters
e:LogEvent — LogEvent instance with logging message information.
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )

Example 
   
   var evt : LogEvent = new LogEvent( LogLevel.INFO, "my message" );
   
   Logger.getInstance().log( evt, PixlibDebug.CHANNEL );

LOG()method 
public static function LOG(o:*, level:LogLevel, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Parameters
o:*
 
level:LogLevel
 
oChannel:EventChannel (default = null)

Returns
Boolean

See also

log()
removeAllListeners()method 
public function removeAllListeners():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes all listeners object from this event channel broadcaster. The object is removed as listener for all events the broadcaster may dispatch on this channel.

removeLogListener()method 
public function removeLogListener(listener:LogListener, oChannel:EventChannel = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener for listening the specified event of the specified channel. The listener could be either an object or a function.

Parameters
listener:LogListener — type name of the event for which unregister the listener
 
oChannel:EventChannel (default = null) — listener object or function to be unregistered

See also

Broadcaster.removeEventListener()
setLevel()method 
public function setLevel(level:LogLevel):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Sets logging level.

Parameters
level:LogLevel — LogLevel filter to apply.
Possible values are :
  • LogLevel.ALL
  • LogLevel.DEBUG
  • LogLevel.WARN
  • LogLevel.ERROR
  • LogLevel.FATAL
  • LogLevel.OFF

See also

LogLevel

Example 
   
   Logger.getInstance().setLevel( LogLevel.INFO );

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 static function WARN(o:*, oChannel:EventChannel = null):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Logs passed-in o message into oChannel logging channel using LogLevel.WARN level filter.

Parameters
o:* — Message to log
 
oChannel:EventChannel (default = null) — (optional) Event channel to use.
If not defined or null, event is dispatched to all logger listeners.

Returns
Boolean — true if success. ( Log level compliant )
Event detail
onLogevent 
Event object type: com.bourre.log.LogEvent.onLogEVENT
onLogEVENT.type property = com.bourre.log.LogEvent.onLogEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a log message is sent.

Defines the value of the type property of the event object for a onLog event.




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