Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ILoggingTarget

Package | mx.logging
Interface | public interface ILoggingTarget
Implementors | AbstractTarget

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

All logger target implementations within the logging framework must implement this interface.

Public Properties

| Property | Defined By
--- | --- | ---
|  | filters : Array In addition to the level setting, filters are used to provide a psuedo-hierarchical mapping for processing only those events for a given category. | ILoggingTarget
|  | level : int Provides access to the level this target is currently set at. | ILoggingTarget

Public Methods

| Method | Defined By
--- | --- | ---
|  | addLogger(logger:ILogger):void Sets up this target with the specified logger. | ILoggingTarget
|  | removeLogger(logger:ILogger):void Stops this target from receiving events from the specified logger. | ILoggingTarget

Property Detail

filters | property

`filters:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

In addition to the `level` setting, filters are used to provide a psuedo-hierarchical mapping for processing only those events for a given category.

Each logger belongs to a category. By convention these categories map to the fully qualified class name in which the logger is used. For example, a logger that is logging messages for the `mx.rpc.soap.WebService` class would use `"mx.rpc.soap.WebService"` as the parameter to the `Log.getLogger()` call. When messages are sent under this category only those targets that have a filter which matches that category will receive notification of those events. Filter expressions may include a wildcard match, indicated with an asterisk. The wildcard must be the right most character in the expression. For example: rpc*, mx.*, or *. If an invalid expression is specified a `InvalidFilterError` will be thrown. No spaces or any of the following characters are valid within a filter expression: []~$^&\/(){}<>+=`!#%?,:;'"@.

Implementation
`public function get filters():Array`
`public function set filters(value:Array):void`
Example

          var traceLogger:ILoggingTarget = new TraceTarget();
          traceLogger.filters = [ "mx.rpc.*", "mx.messaging.*" ];
          Log.addTarget(traceLogger);

level | property |

`level:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the level this target is currently set at. Value values are:

- `LogEventLevel.FATAL` designates events that are very harmful and will eventually lead to application failure
- `LogEventLevel.ERROR` designates error events that might still allow the application to continue running.
- `LogEventLevel.WARN` designates events that could be harmful to the application operation
- `LogEventLevel.INFO` designates informational messages that highlight the progress of the application at coarse-grained level.
- `LogEventLevel.DEBUG` designates informational level messages that are fine grained and most helpful when debugging an application.
- `LogEventLevel.ALL` intended to force a target to process all messages.

Implementation
`public function get level():int`
`public function set level(value:int):void`
Method Detail

addLogger | () | method

`public function addLogger(logger:ILogger):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets up this target with the specified logger. This allows this target to receive log events from the specified logger.

Note: This method is called by the framework and should not be called by you directly.

Parameters

| `logger:ILogger` — The ILogger that this target listens to.

removeLogger | () | method |

`public function removeLogger(logger:ILogger):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Stops this target from receiving events from the specified logger.

Note: This method is called by the framework and should not be called by you directly.

Parameters

| `logger:ILogger` — The ILogger that this target ignores.

Sun Mar 5 2017, 03:42 PM +11:00