com.adobe.flashaccess.sdk.protocol
Class ErrorData

java.lang.Object
  com.adobe.flashaccess.sdk.protocol.ErrorData

Direct Known Subclasses:

AdobeErrorData, CustomErrorData

public abstract class ErrorData
extends java.lang.Object

Base class for all ErrorData. This class contains locale-specific information regarding an error.

Method Summary

int	getErrorCode() The numeric code identifying this error.
java.lang.String	getMessage() The user-friendly text description of the error code.
abstract java.lang.String	getMessage(java.util.Locale loc) The user-friendly text description of the error code.
java.lang.String	getNamespace() The namespace of the error code.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNamespace

public java.lang.String getNamespace()

The namespace of the error code. The presence of a namespace serves the same purpose as namespaces in Java: it allows custom definition of error codes while preventing collisions with existing error codes, as long as the namespace is unique.

Returns:

The namespace of the error code.

getErrorCode

public int getErrorCode()

The numeric code identifying this error.

Returns:

The numeric code identifying this error.

getMessage

public java.lang.String getMessage()

The user-friendly text description of the error code. (This error text is not currently available to client applications.)

Returns:

The user-friendly text description of the error code (using the default locale), or null if no error message was provided.

getMessage

public abstract java.lang.String getMessage(java.util.Locale loc)

The user-friendly text description of the error code.

Parameters:

loc - The locale to use, or null to use the default locale.

Returns:

The user-friendly text description of the error code (using the given locale), or null if no error message was provided.