net.rim.plazmic.mediaengine.io
Class LoadingStatus

java.lang.Object
  |
  +--net.rim.plazmic.mediaengine.io.LoadingStatus

public class LoadingStatus
extends Object

Contains the functionality for describing the media loading status.

This class is used by the MediaManager to notify listeners about loading progress/status.

Since:
JDE 3.7.0

Field Summary
static int LOADING_FAILED
          Represents the LOADING FAILED status code, indicating that the current load has failed.
static int LOADING_FINISHED
          Represents the LOADING FINISHED status code, indicating that the data has finished loading.
static int LOADING_READING
          Represents the LOADING READING status code, indicating that the data is currently being parsed.
static int LOADING_STARTED
          Represents the LOADING STARTED status code, indicating that the media has started loading.
 
Constructor Summary
LoadingStatus()
          Constructs a new status object The default constructor.
 
Method Summary
 int getCode()
          Returns the media code.
 String getContentType()
          Returns the media content type.
 String getMessage()
          Returns the message.
 long getReadBytes()
          Returns the number of bytes read.
 String getSource()
          Returns the URI location of the content.
 int getStatus()
          Returns the loading status code.
 long getTotalBytes()
          Returns the total number of bytes in the content.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail


LOADING_FAILED

public static final int LOADING_FAILED
Represents the LOADING FAILED status code, indicating that the current load has failed.
Since:
JDE 3.7.0

LOADING_FINISHED

public static final int LOADING_FINISHED
Represents the LOADING FINISHED status code, indicating that the data has finished loading.
Since:
JDE 3.7.0

LOADING_READING

public static final int LOADING_READING
Represents the LOADING READING status code, indicating that the data is currently being parsed.
Since:
JDE 3.7.0

LOADING_STARTED

public static final int LOADING_STARTED
Represents the LOADING STARTED status code, indicating that the media has started loading.
Since:
JDE 3.7.0
Constructor Detail

LoadingStatus

public LoadingStatus()
Constructs a new status object The default constructor.
Since:
JDE 3.7.0
Method Detail

getCode

public final int getCode()
Returns the media code.

Used in conjunction with the LOADING_FAILED as the error code

Returns:
An integer representing the code.
Since:
JDE 3.7.0

getContentType

public final String getContentType()
Returns the media content type.

Returns:
A string representing the content type.
Since:
JDE 3.7.0

getMessage

public final String getMessage()
Returns the message.

Used in conjunction with the LOADING_FAILED as the error message

Returns:
The message.
Since:
JDE 3.7.0

getReadBytes

public final long getReadBytes()
Returns the number of bytes read.

Returns:
An integer representing the number of bytes read.
Since:
JDE 3.7.0

getSource

public final String getSource()
Returns the URI location of the content.

Returns:
The location of the content.
Since:
JDE 3.7.0

getStatus

public final int getStatus()
Returns the loading status code.

Returns:
The loading status code. One of: LOADING_STARTED, LOADING_READING, LOADING_FINISHED, LOADING_FAILED.
Since:
JDE 3.7.0

getTotalBytes

public final long getTotalBytes()
Returns the total number of bytes in the content.

Returns:
An integer representing the total number of bytes.
Since:
JDE 3.7.0



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.