Log - BETA ActionScript® 3 (AS3 Flex) Reference for the Adobe® Flash® Platform API Reference

(Preview)

Package	mx.logging
Class	public class Log
Inheritance	Log Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides pseudo-hierarchical logging capabilities with multiple format and output options. The log system consists of two major components, the logger and a target. You can use the logger to send information to a target. The target is responsible for formatting and general output of the log data.

Loggers are singleton instances created for a particular category of information. Typically, the category is the package name of the component that desires to log information. The category provides users the ability to specify what log information they are interested in. Multiple categories can be selected and combined with regular expressions. This allows for both broad and narrow logging information to be acquired. For example, you might be interested in all logging information under the "mx.messaging" and "mx.rpc" packages and want the output from these packages to be formatted as XML. To get the all of the logging information under the "mx.messaging" category including sub-packages and components a wildcard expression is required, such as "mx.messaging.*". See the code example below for more details.

Targets provide the output mechanism of the data being logged. This mechanism typically includes formatting, transmission, or storage, but can be anything possible under the VM. There are two targets provided: MiniDebugTarget and TraceTarget. Each of these writers take the current log information and "sends" it somewhere for display and/or storage. Targets also provide the specification of what log data to output.

More examples

Using the logging API

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addTarget(target:mx.logging:ILoggingTarget):void [static] Allows the specified target to begin receiving notification of log events.	Log
		flush():void [static] This method removes all of the current loggers from the cache.	Log
		getLogger(category:String):ILogger [static] Returns the logger associated with the specified category.	Log
		hasIllegalCharacters(value:String):Boolean [static] This method checks the specified string value for illegal characters.	Log
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDebug():Boolean [static] Indicates whether a debug level log event will be processed by a log target.	Log
		isError():Boolean [static] Indicates whether an error level log event will be processed by a log target.	Log
		isFatal():Boolean [static] Indicates whether a fatal level log event will be processed by a log target.	Log
		isInfo():Boolean [static] Indicates whether an info level log event will be processed by a log target.	Log
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		isWarn():Boolean [static] Indicates whether a warn level log event will be processed by a log target.	Log
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeTarget(target:mx.logging:ILoggingTarget):void [static] Stops the specified target from receiving notification of log events.	Log
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Log - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.logging

addTarget

flush

getLogger

hasIllegalCharacters

isDebug

isError

isFatal

isInfo

isWarn

removeTarget