Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
ILogger

Package | mx.logging
Interface | public interface ILogger extends flash.events.IEventDispatcher
Implementors | LogLogger

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

All loggers within the logging framework must implement this interface.

Public Properties

| Property | Defined By
--- | --- | ---
|  | category : String [read-only] The category value for the logger. | ILogger

Public Methods

| Method | Defined By
--- | --- | ---
|  | debug(message:String, ... rest):void Logs the specified data using the LogEventLevel.DEBUG level. | ILogger
|  | error(message:String, ... rest):void Logs the specified data using the LogEventLevel.ERROR level. | ILogger
|  | fatal(message:String, ... rest):void Logs the specified data using the LogEventLevel.FATAL level. | ILogger
|  | info(message:String, ... rest):void Logs the specified data using the LogEvent.INFO level. | ILogger
|  | log(level:int, message:String, ... rest):void Logs the specified data at the given level. | ILogger
|  | warn(message:String, ... rest):void Logs the specified data using the LogEventLevel.WARN level. | ILogger

Property Detail

category | property

`category:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The category value for the logger.

Implementation
`public function get category():String`
Method Detail

debug | () | method

`public function debug(message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data using the `LogEventLevel.DEBUG` level. `LogEventLevel.DEBUG` designates informational level messages that are fine grained and most helpful when debugging an application.

The string specified for logging can contain braces with an index indicating which additional parameter should be inserted into the string before it is logged. For example "the first additional parameter was {0} the second was {1}" will be translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `message:String` — The information to log. This string can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Additional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.debug("here is some channel info {0} and {1}", 15.4, true);
               // This will log the following String:
          //   "here is some channel info 15.4 and true"

error | () | method |

`public function error(message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data using the `LogEventLevel.ERROR` level. `LogEventLevel.ERROR` designates error events that might still allow the application to continue running.

The string specified for logging can contain braces with an index indicating which additional parameter should be inserted into the string before it is logged. For example "the first additional parameter was {0} the second was {1}" will be translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `message:String` — The information to log. This String can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Additional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.error("here is some channel info {0} and {1}", 15.4, true);
               // This will log the following String:
          //   "here is some channel info 15.4 and true"

fatal | () | method |

`public function fatal(message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data using the `LogEventLevel.FATAL` level. `LogEventLevel.FATAL` designates events that are very harmful and will eventually lead to application failure

The string specified for logging can contain braces with an index indicating which additional parameter should be inserted into the string before it is logged. For example "the first additional parameter was {0} the second was {1}" will be translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `message:String` — The information to log. This String can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Additional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.fatal("here is some channel info {0} and {1}", 15.4, true);
               // This will log the following String:
          //   "here is some channel info 15.4 and true"

info | () | method |

`public function info(message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data using the `LogEvent.INFO` level. `LogEventLevel.INFO` designates informational messages that highlight the progress of the application at coarse-grained level.

The string specified for logging can contain braces with an index indicating which additional parameter should be inserted into the string before it is logged. For example "the first additional parameter was {0} the second was {1}" will be translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `message:String` — The information to log. This String can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Additional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.info("here is some channel info {0} and {1}", 15.4, true);
               // This will log the following String:
          //   "here is some channel info 15.4 and true"

log | () | method |

`public function log(level:int, message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data at the given level.

The String specified for logging can contain braces with an index indicating which additional parameter should be inserted into the String before it is logged. For example "the first additional parameter was {0} the second was {1}" is translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `level:int` — The level this information should be logged at. Valid 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.
| `message:String` — The information to log. This String can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Additional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.log(LogEventLevel.DEBUG, "here is some channel info {0} and {1}", LogEventLevel.DEBUG, 15.4, true);
               // This will log the following String as a DEBUG log message:
          //   "here is some channel info 15.4 and true"

warn | () | method |

`public function warn(message:String, ... rest):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Logs the specified data using the `LogEventLevel.WARN` level. `LogEventLevel.WARN` designates events that could be harmful to the application operation.

The string specified for logging can contain braces with an index indicating which additional parameter should be inserted into the string before it is logged. For example "the first additional parameter was {0} the second was {1}" will be translated into "the first additional parameter was 10 the second was 15" when called with 10 and 15 as parameters.

Parameters

| `message:String` — The information to log. This String can contain special marker characters of the form {x}, where x is a zero based index that will be replaced with the additional parameters found at that index if specified.
| `... rest` — Aadditional parameters that can be subsituted in the str parameter at each "{`x`}" location, where `x` is an integer (zero based) index value into the Array of values specified.

Example

          // Get the logger for the mx.messaging.Channel "category"
          // and send some data to it.
          var logger:ILogger = Log.getLogger("mx.messaging.Channel");
          logger.warn("here is some channel info {0} and {1}", 15.4, true);
               // This will log the following String:
          //   "here is some channel info 15.4 and true"

Wed Nov 15 2017, 09:50 AM +01:00