Packagesekati.log
Classpublic final class Logger
InheritanceLogger Inheritance flash.events.EventDispatcher
ImplementsILogger

Logger provides a common logging facility for applications implementing the API.


Public Properties
 PropertyDefined by
  $ : Logger
[static][read-only] Shorthand singleton accessor getter
Logger
  enabled : Boolean
Logger enabled status.
Logger
  _instance : Logger
[static]
Logger
  outputMode : uint
Handles which output mode(s) the Logger should act upon.
Logger
  settings : String
[read-only] Returns level and filter settings.
Logger
Public Methods
 MethodDefined by
  
Logger($:SingletonEnforcer = null)
Logger Singleton Constructor
Logger
  
debug(origin:Object, message:String):void
debug is a log level denoting an informational event which may require investigation.
Logger
  
destroy():void
Destroy the Logger Singleton instance.
Logger
  
error(origin:Object, message:String):void
error is a log level denoting a error type event.
Logger
  
fatal(origin:Object, message:String):void
fatal is a log level denoting a fatal type event.
Logger
  
getFilters():String
Returns a stringified overview of all filters statuses.
Logger
  
getInstance():Logger
[static] Singleton Accessor
Logger
  
getLevels():String
Returns a stringified overview of all levels statuses.
Logger
  
info(origin:Object, message:String):void
info is a log level denoting an informational event.
Logger
  
isFiltered(origin:Object):Boolean
Check if an origin's output is being filtered
Logger
  
notice(origin:Object, message:String):void
notice is a log level denoting an event of interest.
Logger
  
object(origin:Object):void
object is a special log level which delivers origin object recursion.
Logger
  
reset():void
Reset our default levels and filters.
Logger
  
resetFilters():void
Reset all filters (clearing previous filters)
Logger
  
resetLevels():void
Reset all levels
Logger
  
setAllLevels(isEnabled:Boolean):void
Enable or disable all existing levels.
Logger
  
setFilter(origin:Object, isFiltered:Boolean):void
Enable/disable a filter and create the filter if it does not already exist.
Logger
  
setLevel(level:String, isEnabled:Boolean):void
Enable/disable a log level.
Logger
  
status(origin:Object, message:String):void
status is a log level denoting a status message.
Logger
  
trace(origin:Object, message:String):void
trace is a log level denoting a standard log event.
Logger
  
warn(origin:Object, message:String):void
warn is a log level denoting an event of concern.
Logger
Property detail
$property
$:Logger  [read-only]

Shorthand singleton accessor getter

Implementation
    public static function get $():Logger
enabledproperty 
enabled:Boolean  [read-write]

Logger enabled status.

Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
_instanceproperty 
public static var _instance:Logger
outputModeproperty 
outputMode:uint  [read-write]

Handles which output mode(s) the Logger should act upon.

Implementation
    public function get outputMode():uint
    public function set outputMode(value:uint):void

See also

sekati.log.LogTarget
settingsproperty 
settings:String  [read-only]

Returns level and filter settings.

Implementation
    public function get settings():String
Constructor detail
Logger()constructor
public function Logger($:SingletonEnforcer = null)

Logger Singleton Constructor

Parameters
$:SingletonEnforcer (default = null) — SingletonEnforcer - internal to the AS file; the param prevents external instantiation without error.
Method detail
debug()method
public function debug(origin:Object, message:String):void

debug is a log level denoting an informational event which may require investigation.

Parameters
origin:Object
 
message:String
destroy()method 
public function destroy():void

Destroy the Logger Singleton instance.

error()method 
public function error(origin:Object, message:String):void

error is a log level denoting a error type event.

Parameters
origin:Object
 
message:String
fatal()method 
public function fatal(origin:Object, message:String):void

fatal is a log level denoting a fatal type event.

Parameters
origin:Object
 
message:String
getFilters()method 
public function getFilters():String

Returns a stringified overview of all filters statuses.

Returns
String
getInstance()method 
public static function getInstance():Logger

Singleton Accessor

Returns
Logger — Logger
getLevels()method 
public function getLevels():String

Returns a stringified overview of all levels statuses.

Returns
String
info()method 
public function info(origin:Object, message:String):void

info is a log level denoting an informational event.

Parameters
origin:Object
 
message:String
isFiltered()method 
public function isFiltered(origin:Object):Boolean

Check if an origin's output is being filtered

Parameters
origin:Object — to check.

Returns
Boolean
notice()method 
public function notice(origin:Object, message:String):void

notice is a log level denoting an event of interest.

Parameters
origin:Object
 
message:String
object()method 
public function object(origin:Object):void

object is a special log level which delivers origin object recursion.

Parameters
origin:Object

See also

sekati.log.Inspector
reset()method 
public function reset():void

Reset our default levels and filters.

resetFilters()method 
public function resetFilters():void

Reset all filters (clearing previous filters)

resetLevels()method 
public function resetLevels():void

Reset all levels

setAllLevels()method 
public function setAllLevels(isEnabled:Boolean):void

Enable or disable all existing levels.

Parameters
isEnabled:Boolean — enabled status
setFilter()method 
public function setFilter(origin:Object, isFiltered:Boolean):void

Enable/disable a filter and create the filter if it does not already exist.

Parameters
origin:Object — object to filter on [usually a string]
 
isFiltered:Boolean
setLevel()method 
public function setLevel(level:String, isEnabled:Boolean):void

Enable/disable a log level.

Parameters
level:String — level name
 
isEnabled:Boolean — enabled status
status()method 
public function status(origin:Object, message:String):void

status is a log level denoting a status message.

Parameters
origin:Object
 
message:String
trace()method 
public function trace(origin:Object, message:String):void

trace is a log level denoting a standard log event.

Parameters
origin:Object
 
message:String
warn()method 
public function warn(origin:Object, message:String):void

warn is a log level denoting an event of concern.

Parameters
origin:Object
 
message:String



Copyright © 2008-2012 jason m horwitz, Sekati LLC. All Rights Reserved.