com.adobe.gravity.utility.logging

# ILogger - AS3 ADEP Client Component

Package | com.adobe.gravity.utility.logging
Interface | public interface ILogger
Implementors | GravityBootstrap, GravityInit

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

The ILogger interface represents a logger. Typically a logger will be retrieved via Logger.getLogger.

Public Methods

| Method | Defined By
--- | --- | ---
|  | isLoggable(level:int, loggerName:String):Boolean Determine whether a message will be logged. | ILogger
|  | log(level:int, timestamp:Date, sequence:Number, loggerName:String, message:String, params:Object, actor:Object, error:Error):void Log a message. | ILogger

Method Detail

### isLoggable

()
method

`public function isLoggable(level:int, loggerName:String):Boolean`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

Determine whether a message will be logged.

Parameters

| `level:int` — The logging level of the message.
| `loggerName:String` — The name of the logger to which the message is to be logged.

Returns

| `Boolean` — true if the message will be logged, false otherwise.

### log

()
method

`public function log(level:int, timestamp:Date, sequence:Number, loggerName:String, message:String, params:Object, actor:Object, error:Error):void`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

Log a message.

Parameters

| `level:int` — The logging level for the message, for example LogLevel.INFO.
| `timestamp:Date` — The timestamp for the logged event.
| `sequence:Number` — A sequence number for absolutely ordering log events, should be computed via Sequence.next().
| `loggerName:String` — The name of the logger. Used for log filtering.
| `message:String` — The log message, will be formatted with FormatMessage.formatString using the provided params object as parameters.
| `params:Object` — Any parameters associated with this message. Used to format the message with FormatMessage.formatString, but also useful to provide additional context for the message. Can be null if there are no parameters.
| `actor:Object` — The originating object for the log message. Used by some loggers to differentiate messages generated by different instances of a class. Can be null if there is no obvious actor.
| `error:Error` — If the message relates to an error, the Error object can be provided. Can be null if there is no associated error object.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00