com.adobe.flashaccess.sdk.protocol
Class CustomErrorData

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

public class CustomErrorData
extends ErrorData

Customer-specific custom error data. This class can be used to pass back customer-specific errors from the server to a requesting client if the existing Adobe Flash Access errors are not suitable. The error code will be visible to client applications, but the message text is not provided to the client in Flash Access 2.0.

The message text should be locale-specific.

Field Summary

static java.lang.String

CUSTOM_NAMESPACE The namespace used for application-defined errors.

Constructor Summary

CustomErrorData(int errorCode)
Creates a CustomErrorData object.

CustomErrorData(int errorCode, java.lang.String message)
Creates a CustomErrorData object.

Method Summary

java.lang.String

getMessage(java.util.Locale loc) Retrieves the message provided to the constructor, disregarding the locale parameter, if present.

Methods inherited from class com.adobe.flashaccess.sdk.protocol.ErrorData

getErrorCode, getMessage, getNamespace

Methods inherited from class java.lang.Object

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

Field Detail

CUSTOM_NAMESPACE

public static final java.lang.String CUSTOM_NAMESPACE

The namespace used for application-defined errors.

See Also:

Constant Field Values

Constructor Detail

CustomErrorData

public CustomErrorData(int errorCode,
                       java.lang.String message)

Creates a CustomErrorData object.

Parameters:

errorCode - The error code.

message - The friendly text description of the error code.

CustomErrorData

public CustomErrorData(int errorCode)

Creates a CustomErrorData object.

Parameters:

errorCode - The error code.

Method Detail

getMessage

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

Retrieves the message provided to the constructor, disregarding the locale parameter, if present.

Specified by:

getMessage in class ErrorData

Parameters:

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

Returns:

The message provided to the constructor.

See Also:

ErrorData.getMessage(java.util.Locale)