net.rim.plazmic.mediaengine
Class MediaException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--net.rim.plazmic.mediaengine.MediaException

public class MediaException

extends Exception

Contains the functionality for all exceptions specific to this framework.

Since:

JDE 3.7.0

Field Summary

static int	CHECKSUM_MISMATCH Represents an error that occurs when the checksum fails.
static int	INTERRUPTED_DOWNLOAD Represents an error that occurs when the requested download operation was cancelled.
static int	INVALID_HEADER Represents an error that occurs when the requested media is of an unsupported format.
static int	OUT_OF_BOUNDS Represents an error that occurs when an array index is out of bounds or when reading from an input stream after EOF.
static String	rcsId Represents the RCS ID.
static int	REQUEST_TIMED_OUT Represents an error that occurs when the request timed out.
static int	UNSUPPORTED_TYPE Represents an error that occurs when the requested media format is not supported.
static int	UPGRADE_MEDIA Represents an error that occurs when the current version of the media engine no longer supports a requested feature.
static int	UPGRADE_PLAYER Represents an error that occurs when the current version of the media engine is not compatible with a requested feature.

Constructor Summary

MediaException()
Constructs a MediaException.

MediaException(int code)
Constructs a MediaException given an error code.

MediaException(int code, String msg)
Constructs a MediaException given both an error code and detailed message describing the cause of the exception.

MediaException(String msg)
Constructs a MediaException with a detailed message describing the circumstances of the exception.

Method Summary

int	getCode() Returns the current error code.

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

rcsId

public static final String rcsId

Represents the RCS ID.

Produces identifiers in the compiled code that identify which version number of the source code was used.

Since:

JDE 3.7.0

UPGRADE_PLAYER

public static final int UPGRADE_PLAYER

Represents an error that occurs when the current version of the media engine is not compatible with a requested feature.

Since:

JDE 3.7.0

UPGRADE_MEDIA

public static final int UPGRADE_MEDIA

Represents an error that occurs when the current version of the media engine no longer supports a requested feature.

Since:

JDE 3.7.0

INVALID_HEADER

public static final int INVALID_HEADER

Represents an error that occurs when the requested media is of an unsupported format.

Since:

JDE 3.7.0

OUT_OF_BOUNDS

public static final int OUT_OF_BOUNDS

Represents an error that occurs when an array index is out of bounds or when reading from an input stream after EOF.

Since:

JDE 3.7.0

INTERRUPTED_DOWNLOAD

public static final int INTERRUPTED_DOWNLOAD

Represents an error that occurs when the requested download operation was cancelled.

Since:

JDE 3.7.0

REQUEST_TIMED_OUT

public static final int REQUEST_TIMED_OUT

Represents an error that occurs when the request timed out.

Since:

JDE 3.7.0

UNSUPPORTED_TYPE

public static final int UNSUPPORTED_TYPE

Represents an error that occurs when the requested media format is not supported.

Since:

JDE 3.7.0

CHECKSUM_MISMATCH

public static final int CHECKSUM_MISMATCH

Represents an error that occurs when the checksum fails.

Since:

JDE 3.7.0

Constructor Detail

MediaException

public MediaException()

Constructs a MediaException.

This is the default exception constructor.

Since:

JDE 3.7.0

MediaException

public MediaException(String msg)

Constructs a MediaException with a detailed message describing the circumstances of the exception.

Parameters:

msg - A description of the cause of the exception.

Since:

JDE 3.7.0

MediaException

public MediaException(int code)

Constructs a MediaException given an error code.

Parameters:

code - An integer representing the error code that caused the exception.

Since:

JDE 3.7.0

MediaException

public MediaException(int code,
                      String msg)

Constructs a MediaException given both an error code and detailed message describing the cause of the exception.

Parameters:

code - An error code describing the cause of the exception.

msg - A message describing the cause of the exception.

Since:

JDE 3.7.0

Method Detail

getCode

public int getCode()

Returns the current error code.

If the returned code is >= 200, the code represents a standard HTTP response code.

Returns:

An integer representing the error code.

Since:

JDE 3.7.0