Per requested by API council, rename MediaScannerConneciton.ScanResultListener to .OnScanCompletedListener
http://2553871
Change-Id: I293b8138a2c23ea107b634da014902f838966c0e
diff --git a/api/current.xml b/api/current.xml
index 692cb16..e231528 100644
--- a/api/current.xml
+++ b/api/current.xml
@@ -85230,7 +85230,7 @@
</parameter>
<parameter name="mimeTypes" type="java.lang.String[]">
</parameter>
-<parameter name="callback" type="android.media.MediaScannerConnection.ScanResultListener">
+<parameter name="callback" type="android.media.MediaScannerConnection.OnScanCompletedListener">
</parameter>
</method>
</class>
@@ -85241,7 +85241,7 @@
deprecated="not deprecated"
visibility="public"
>
-<implements name="android.media.MediaScannerConnection.ScanResultListener">
+<implements name="android.media.MediaScannerConnection.OnScanCompletedListener">
</implements>
<method name="onMediaScannerConnected"
return="void"
@@ -85270,7 +85270,7 @@
</parameter>
</method>
</interface>
-<interface name="MediaScannerConnection.ScanResultListener"
+<interface name="MediaScannerConnection.OnScanCompletedListener"
abstract="true"
static="true"
final="false"
diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java
index ee87290..3a2aa55 100644
--- a/core/java/android/content/Context.java
+++ b/core/java/android/content/Context.java
@@ -25,7 +25,6 @@
import android.database.sqlite.SQLiteDatabase.CursorFactory;
import android.graphics.Bitmap;
import android.graphics.drawable.Drawable;
-import android.media.MediaScannerConnection.ScanResultListener;
import android.net.Uri;
import android.os.Bundle;
import android.os.Handler;
@@ -444,7 +443,7 @@
* are not automatically scanned by the media scanner, you can explicitly
* add them to the media database with
* {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[],
- * ScanResultListener) MediaScannerConnection.scanFile}.
+ * OnScanCompletedListener) MediaScannerConnection.scanFile}.
* Note that this is not the same as
* {@link android.os.Environment#getExternalStoragePublicDirectory
* Environment.getExternalStoragePublicDirectory()}, which provides
diff --git a/media/java/android/media/MediaScannerConnection.java b/media/java/android/media/MediaScannerConnection.java
index 65b67a1..503b5f4 100644
--- a/media/java/android/media/MediaScannerConnection.java
+++ b/media/java/android/media/MediaScannerConnection.java
@@ -30,11 +30,11 @@
/**
- * MediaScannerConnection provides a way for applications to pass a
+ * MediaScannerConnection provides a way for applications to pass a
* newly created or downloaded media file to the media scanner service.
- * The media scanner service will read metadata from the file and add
+ * The media scanner service will read metadata from the file and add
* the file to the media content provider.
- * The MediaScannerConnectionClient provides an interface for the
+ * The MediaScannerConnectionClient provides an interface for the
* media scanner service to return the Uri for a newly scanned file
* to the client of the MediaScannerConnection class.
*/
@@ -46,7 +46,7 @@
private MediaScannerConnectionClient mClient;
private IMediaScannerService mService;
private boolean mConnected; // true if connect() has been called since last disconnect()
-
+
private IMediaScannerListener.Stub mListener = new IMediaScannerListener.Stub() {
public void scanCompleted(String path, Uri uri) {
MediaScannerConnectionClient client = mClient;
@@ -60,36 +60,36 @@
* Interface for notifying clients of the result of scanning a
* requested media file.
*/
- public interface ScanResultListener {
+ public interface OnScanCompletedListener {
/**
* Called to notify the client when the media scanner has finished
* scanning a file.
* @param path the path to the file that has been scanned.
- * @param uri the Uri for the file if the scanning operation succeeded
- * and the file was added to the media database, or null if scanning failed.
- */
+ * @param uri the Uri for the file if the scanning operation succeeded
+ * and the file was added to the media database, or null if scanning failed.
+ */
public void onScanCompleted(String path, Uri uri);
}
-
+
/**
* An interface for notifying clients of MediaScannerConnection
* when a connection to the MediaScanner service has been established
* and when the scanning of a file has completed.
*/
- public interface MediaScannerConnectionClient extends ScanResultListener {
+ public interface MediaScannerConnectionClient extends OnScanCompletedListener {
/**
- * Called to notify the client when a connection to the
+ * Called to notify the client when a connection to the
* MediaScanner service has been established.
- */
+ */
public void onMediaScannerConnected();
-
+
/**
* Called to notify the client when the media scanner has finished
* scanning a file.
* @param path the path to the file that has been scanned.
- * @param uri the Uri for the file if the scanning operation succeeded
- * and the file was added to the media database, or null if scanning failed.
- */
+ * @param uri the Uri for the file if the scanning operation succeeded
+ * and the file was added to the media database, or null if scanning failed.
+ */
public void onScanCompleted(String path, Uri uri);
}
@@ -140,7 +140,7 @@
}
}
}
-
+
/**
* Returns whether we are connected to the media scanner service
* @return true if we are connected, false otherwise
@@ -151,9 +151,9 @@
/**
* Requests the media scanner to scan a file.
- * Success or failure of the scanning operation cannot be determined until
+ * Success or failure of the scanning operation cannot be determined until
* {@link MediaScannerConnectionClient#onScanCompleted(String, Uri)} is called.
- *
+ *
* @param path the path to the file to be scanned.
* @param mimeType an optional mimeType for the file.
* If mimeType is null, then the mimeType will be inferred from the file extension.
@@ -175,31 +175,31 @@
}
}
}
-
+
static class ClientProxy implements MediaScannerConnectionClient {
final String[] mPaths;
final String[] mMimeTypes;
- final ScanResultListener mClient;
+ final OnScanCompletedListener mClient;
MediaScannerConnection mConnection;
int mNextPath;
-
- ClientProxy(String[] paths, String[] mimeTypes, ScanResultListener client) {
+
+ ClientProxy(String[] paths, String[] mimeTypes, OnScanCompletedListener client) {
mPaths = paths;
mMimeTypes = mimeTypes;
mClient = client;
}
-
+
public void onMediaScannerConnected() {
scanNextPath();
}
-
+
public void onScanCompleted(String path, Uri uri) {
if (mClient != null) {
mClient.onScanCompleted(path, uri);
}
scanNextPath();
}
-
+
void scanNextPath() {
if (mNextPath >= mPaths.length) {
mConnection.disconnect();
@@ -210,7 +210,7 @@
mNextPath++;
}
}
-
+
/**
* Convenience for constructing a {@link MediaScannerConnection}, calling
* {@link #connect} on it, and calling {@link #scanFile} with the given
@@ -218,7 +218,7 @@
* established.
* @param context The caller's Context, required for establishing a connection to
* the media scanner service.
- * Success or failure of the scanning operation cannot be determined until
+ * Success or failure of the scanning operation cannot be determined until
* {@link MediaScannerConnectionClient#onScanCompleted(String, Uri)} is called.
* @param paths Array of paths to be scanned.
* @param mimeTypes Optional array of MIME types for each path.
@@ -229,13 +229,13 @@
* @see scanFile(String, String)
*/
public static void scanFile(Context context, String[] paths, String[] mimeTypes,
- ScanResultListener callback) {
+ OnScanCompletedListener callback) {
ClientProxy client = new ClientProxy(paths, mimeTypes, callback);
MediaScannerConnection connection = new MediaScannerConnection(context, client);
client.mConnection = connection;
connection.connect();
}
-
+
/**
* Part of the ServiceConnection interface. Do not call.
*/
