drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am b350bec5: am 17876aa5: Minor changes to ContentProvider javadoc to improve consistency.

Browse Source 
Merge commit 'b350bec514eb9fee473e4ef62680c53e992dc49b' into gingerbread-plus-aosp

* commit 'b350bec514eb9fee473e4ef62680c53e992dc49b':
  Minor changes to ContentProvider javadoc to improve consistency.
This commit is contained in:
Dan Egnor
2010-07-28 12:42:16 -07:00
committed by Android Git Automerger
parent 84665f6dc2 b350bec514
commit 8190f48553
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
core/java/android/content/ContentProvider.java
View File

@ -438,7 +438,7 @@ public abstract class ContentProvider implements ComponentCallbacks {
* turns out not to be needed, and stops database errors (such as a full * turns out not to be needed, and stops database errors (such as a full
* disk) from halting application launch. * disk) from halting application launch.
* *
* <p>For SQL databases, {@link android.database.sqlite.SQLiteOpenHelper} * <p>If you use SQLite, {@link android.database.sqlite.SQLiteOpenHelper}
* is a helpful utility class that makes it easy to manage databases, * is a helpful utility class that makes it easy to manage databases,
* and will automatically defer opening until first use. If you do use * and will automatically defer opening until first use. If you do use
* SQLiteOpenHelper, make sure to avoid calling * SQLiteOpenHelper, make sure to avoid calling
@ -606,7 +606,7 @@ public abstract class ContentProvider implements ComponentCallbacks {
public abstract int delete(Uri uri, String selection, String[] selectionArgs); public abstract int delete(Uri uri, String selection, String[] selectionArgs);
/** /**
* Implement this to update one or more rows. * Implement this to handle requests to update one or more rows.
* The implementation should update all rows matching the selection * The implementation should update all rows matching the selection
* to set the columns according to the provided values map. * to set the columns according to the provided values map.
* As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()} * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()}
@ -626,14 +626,14 @@ public abstract class ContentProvider implements ComponentCallbacks {
String[] selectionArgs); String[] selectionArgs);
/** /**
* Override this to open a file blob associated with a content URI. * Override this to handle requests to open a file blob.
* The default implementation always throws {@link FileNotFoundException}. * The default implementation always throws {@link FileNotFoundException}.
* This method can be called from multiple threads, as described in * This method can be called from multiple threads, as described in
* <a href="{@docRoot}guide/topics/fundamentals.html#procthread">Application Fundamentals: * <a href="{@docRoot}guide/topics/fundamentals.html#procthread">Application Fundamentals:
* Processes and Threads</a>. * Processes and Threads</a>.
* *
* <p>Returns a ParcelFileDescriptor, which is returned directly to the * <p>This method returns a ParcelFileDescriptor, which is returned directly
* caller. This way large data (such as images and documents) can be * to the caller. This way large data (such as images and documents) can be
* returned without copying the content. * returned without copying the content.
* *
* <p>The returned ParcelFileDescriptor is owned by the caller, so it is * <p>The returned ParcelFileDescriptor is owned by the caller, so it is
@ -671,7 +671,7 @@ public abstract class ContentProvider implements ComponentCallbacks {
* Processes and Threads</a>. * Processes and Threads</a>.
* *
* <p>If you implement this, your clients must be able to deal with such * <p>If you implement this, your clients must be able to deal with such
* files, either directly with * file slices, either directly with
* {@link ContentResolver#openAssetFileDescriptor}, or by using the higher-level * {@link ContentResolver#openAssetFileDescriptor}, or by using the higher-level
* {@link ContentResolver#openInputStream ContentResolver.openInputStream} * {@link ContentResolver#openInputStream ContentResolver.openInputStream}
* or {@link ContentResolver#openOutputStream ContentResolver.openOutputStream} * or {@link ContentResolver#openOutputStream ContentResolver.openOutputStream}
@ -792,11 +792,12 @@ public abstract class ContentProvider implements ComponentCallbacks {
} }
/** /**
* Override this to perform a batch of operations, or the default * Override this to handle requests to perform a batch of operations, or the
* implementation will {@link ContentProviderOperation#apply} each of the * default implementation will iterate over the operations and call
* {@link ContentProviderOperation} objects. If the apply calls all succeed * {@link ContentProviderOperation#apply} on each of them.
* then a {@link ContentProviderResult} array with the same number of * If all calls to {@link ContentProviderOperation#apply} succeed
* elements as the operations will be returned. If any of the apply calls * then a {@link ContentProviderResult} array with as many
* elements as there were operations will be returned. If any of the calls
* fail, it is up to the implementation how many of the others take effect. * fail, it is up to the implementation how many of the others take effect.
* This method can be called from multiple threads, as described in * This method can be called from multiple threads, as described in
* <a href="{@docRoot}guide/topics/fundamentals.html#procthread">Application Fundamentals: * <a href="{@docRoot}guide/topics/fundamentals.html#procthread">Application Fundamentals: