Packagede.flamelab.log
Classpublic class AbstractLogWriter
InheritanceAbstractLogWriter Inheritance flash.events.EventDispatcher
SubclassesLogWriterAirFile, LogWriterAirSqlite, LogWriterFirebug

Abstract class for all writer implementations. A writer is an implmentation of a certain loggin mechanism, e.g. write entries to a database or to a log file. This class provides some basic features for adding filters and formatters and for invoking the logging. A basic formatter is created for a simple formatting. This can be override with each concrete writers by invoking the setFormatter() method. Each concrete writer must implement the writer() and shutdown() methods.


Public Methods
 MethodDefined by
  
AbstractLogWriter()
Constructor, sets default formatter instance for writer.
AbstractLogWriter
  
addFilter(filter:ILogFilter):void
Add a filter to writer's filter list.
AbstractLogWriter
  
filter(event:LogEvent):Boolean
Filter log data with applied filters.
AbstractLogWriter
  
format(event:LogEvent):String
Format output by formatter.
AbstractLogWriter
  
getEnabled():Boolean
Get enabled state of writer
AbstractLogWriter
  
log(event:LogEvent):void
Log given log event according to writers implementation.
AbstractLogWriter
  
setEnabled(state:Boolean):void
Enable or disable writer.
AbstractLogWriter
  
setFormatter(formatter:ILogFormatter):void
Set formatter instance for writer.
AbstractLogWriter
  
shutdown():void
Clean up writer specific issues (e.g.
AbstractLogWriter
  
write(event:LogEvent):void
Concrete implementation of logging method.
AbstractLogWriter
Constructor detail
AbstractLogWriter()constructor
public function AbstractLogWriter()

Constructor, sets default formatter instance for writer.

Method detail
addFilter()method
public function addFilter(filter:ILogFilter):void

Add a filter to writer's filter list. A writter can have multiple filters applied.

Parameters
filter:ILogFilter — ILogFilter object which implements a filtering
filter()method 
public function filter(event:LogEvent):Boolean

Filter log data with applied filters. Returns true only if data passes all added filters.

Parameters
event:LogEvent — Log event containig all log related information

Returns
Boolean — Boolean true if all filters are passed successfully false if one or more filters fail
format()method 
public function format(event:LogEvent):String

Format output by formatter.

Parameters
event:LogEvent — Log event containig all log related information

Returns
String — String formatted output by formatter
getEnabled()method 
public function getEnabled():Boolean

Get enabled state of writer

Returns
Boolean — Boolean true if writer is enabled false if writer is disabled
log()method 
public function log(event:LogEvent):void

Log given log event according to writers implementation.

Parameters
event:LogEvent — Log event containig all log related information
setEnabled()method 
public function setEnabled(state:Boolean):void

Enable or disable writer.

Parameters
state:Boolean — true if writer should be enabled false if writer is diabled
setFormatter()method 
public function setFormatter(formatter:ILogFormatter):void

Set formatter instance for writer. Each writer can only have one formatter.

Parameters
formatter:ILogFormatter — Intance of ILogFormatter used to format output
shutdown()method 
public function shutdown():void

Clean up writer specific issues (e.g. close connections and handlers). Must be implemented by concrete writer implementations

write()method 
public function write(event:LogEvent):void

Concrete implementation of logging method. Must be implemented by concrete writer implementations

Parameters
event:LogEvent — Log event containig all log related information



copyright 2009 by flamelab.de