ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.utility.error 

AugmentedError  - AS3 ADEP Client Component

Packagecom.adobe.gravity.utility.error
Classpublic class AugmentedError
InheritanceAugmentedError Inheritance Error Inheritance Object
Subclasses AggregatingTokenError

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 AugmentedError class extends the standard Error class to provide access to error parameters and access to the original error(s). As such AugmentedError (or a subclass) should be preferred to the standard Error class wherever a runtime error is thrown.



Public Properties
 PropertyDefined By
  causes : Array
[read-only] An array of causes.
AugmentedError
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error message.
Error
  identifier : String
[read-only] The error identifier.
AugmentedError
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
  parameterNamespace : String
[read-only] The parameter namespace.
AugmentedError
  parameters : Object
[read-only] The error parameters.
AugmentedError
Public Methods
 MethodDefined By
  
AugmentedError(identifier:String = null, message:String = null, parameters:Object = null, parameterNamespace:String = null, cause:Object = null)
Constructor.
AugmentedError
 Inherited
Returns the call stack for an error at the time of the error's construction as a string.
Error
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.
Error
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

causes

property
causes:Array  [read-only]

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

An array of causes. Note that it is always a non-null Array, even if null or a non-Array object is passed into the constructor. Also note that while the contents of the Array will usually be Error objects, this is not enforced and so code that iterates through the causes should be prepared to deal with non-Error objects.



Implementation
    public function get causes():Array

identifier

property 
identifier:String  [read-only]

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 error identifier. By default the name property will have the same value, although the name property can be set to a different value after construction.



Implementation
    public function get identifier():String

parameterNamespace

property 
parameterNamespace:String  [read-only]

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 parameter namespace.



Implementation
    public function get parameterNamespace():String

parameters

property 
parameters:Object  [read-only]

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 error parameters. Note that this object will never be null, even if null was passed into the constructor.



Implementation
    public function get parameters():Object
Constructor Detail

AugmentedError

()Constructor
public function AugmentedError(identifier:String = null, message:String = null, parameters:Object = null, parameterNamespace:String = null, cause:Object = null)

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

Constructor.

The message of the parent Error class is created by passing the message and parameters objects directly to the FormatMessage.formatString(...) call.

The parameterNamespace parameter can be used by aggregation systems (such as a logging framework) to distinguish parameters that have the same name but different semantics. For example, "taskId" might be a parameter for both a deferred execution mechanism and a To Do list subsystem. For an aggregation system to distinguish between the two, the deferred execution mechanism might be given a namespace of "edu.someuniversity.DeferredExecution" while the To Do list subsystem might have a namespace of "com.somecompany.subsystem.todo". Parameters
identifier:String (default = null) — The identifier for the error. The intention is that this identifier can be used to uniquely identify the error despite localization or changes in message wording. The name property is also initialized to this value. Can be null, in which case the name property will be initialized to "AugmentedError".
 
message:String (default = null) — The text of the message. This parameter will be passed to FormatMessage.formatString(...) with the specified parameters for parameter substitution.
 
parameters:Object (default = null) — An object with a property for each parameter that is to be substituted into the error message. May be null (which means there are no parameters to be substituted).
 
parameterNamespace:String (default = null) — Similar to an XML namespace, prevents error parameters that have the same name but different semantics from being confused. Generally code from a single team or company would have a single namespace. May be null (which should be considered the "global" namespace).
 
cause:Object (default = null) — The cause of this error. This is generally either a single Error object from a catch statement that is being wrapped into a higher-level error, or an Array of Error objects from catch statements (in the case of an aggregate operation where multiple independent errors may occur, such as synchronization). However, objects that are thrown are not necessarily Error objects, so the cause parameter may be something other than an Error or an Array of Error objects. May be null. If it is an Array, the items will be copied so that changes to the original Array will not affect this Error object (although changes to members of the Array may affect members of the causes Array).

Related API Elements