javax.microedition.pim
Class PIMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.microedition.pim.PIMException

public class PIMException

extends java.lang.Exception

Represents exceptions thrown by the PIM classes. This class has a reason code optionally associated with it to provide more information about the PIM exception that occurred.

Since:

PIM 1.0

Field Summary

static int	FEATURE_NOT_SUPPORTED Indicates a PIM exception where the functionality is not supported in this implementation.
static int	GENERAL_ERROR Indicates a general PIM exception error.
static int	LIST_CLOSED Indicates a PIM exception where a list is closed and access is attempted.
static int	LIST_NOT_ACCESSIBLE Indicates a PIM exception where a list is no longer accessible by the application, such as if the underlying PIM database is deleted.
static int	MAX_CATEGORIES_EXCEEDED Indicates the max number of categories is exceeded.
static int	UNSUPPORTED_VERSION Indicates the data is in an unsupported PIM version.
static int	UPDATE_ERROR Indicates a PIM exception where the update could not continue.

Constructor Summary

PIMException()
Constructs a new instance of this class with its stack trace filled in.

PIMException(java.lang.String detailMessage)
Constructs a new instance of this class with its stacktrace and message filled in.

PIMException(java.lang.String detailMessage, int reason)
Constructs a new instance of this class with its stacktrace, message, and reason filled in.

Method Summary

int	getReason() Returns the reason for the PIM Exception.

Methods inherited from class java.lang.Throwable

getMessage, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_NOT_SUPPORTED

public static final int FEATURE_NOT_SUPPORTED

Indicates a PIM exception where the functionality is not supported in this implementation.

See Also:

Constant Field Values

GENERAL_ERROR

public static final int GENERAL_ERROR

Indicates a general PIM exception error. This is the default value for the reason code.

See Also:

Constant Field Values

LIST_CLOSED

public static final int LIST_CLOSED

Indicates a PIM exception where a list is closed and access is attempted.

See Also:

Constant Field Values

LIST_NOT_ACCESSIBLE

public static final int LIST_NOT_ACCESSIBLE

Indicates a PIM exception where a list is no longer accessible by the application, such as if the underlying PIM database is deleted.

See Also:

Constant Field Values

MAX_CATEGORIES_EXCEEDED

public static final int MAX_CATEGORIES_EXCEEDED

Indicates the max number of categories is exceeded.

See Also:

Constant Field Values

UNSUPPORTED_VERSION

public static final int UNSUPPORTED_VERSION

Indicates the data is in an unsupported PIM version.

See Also:

Constant Field Values

UPDATE_ERROR

public static final int UPDATE_ERROR

Indicates a PIM exception where the update could not continue.

See Also:

Constant Field Values

Constructor Detail

PIMException

public PIMException()

Constructs a new instance of this class with its stack trace filled in. The reason code for this exception is set to the default value of GENERAL_ERROR.

PIMException

public PIMException(java.lang.String detailMessage)

Constructs a new instance of this class with its stacktrace and message filled in. The reason code for this exception is set to the default value of GENERAL_ERROR.

Parameters:

detailMessage - String The detail message for the exception.

PIMException

public PIMException(java.lang.String detailMessage,
                    int reason)

Constructs a new instance of this class with its stacktrace, message, and reason filled in.

Parameters:

detailMessage - String The detail message for the exception.

reason - int Integer representing the reason for the exception.

Method Detail

getReason

public int getReason()

Returns the reason for the PIM Exception. The int returned is one of the static error reason values defined in this class.

Returns:

int reason for the exception.