Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ContentProviderClient

extends Object
java.lang.Object
   ↳ android.content.ContentProviderClient

Class Overview

The public interface object used to interact with a ContentProvider . This is obtained by calling acquireContentProviderClient(Uri) . This object must be released using release() in order to indicate to the system that the ContentProvider is no longer needed and can be killed to free up resources.

Note that you should generally create a new ContentProviderClient instance for each thread that will be performing operations. Unlike ContentResolver , the methods here such as query(Uri, String[], String, String[], String) and openFile(Uri, String) are not thread safe -- you must not call release() on the ContentProviderClient those calls are made from until you are finished with the data they have returned.

Summary

Public Methods
ContentProviderResult[] )">applyBatch ( ArrayList < ContentProviderOperation > operations)
See )">ContentProvider.applyBatch
int bulkInsert ( Uri url, ContentValues[] initialValues)
See ContentProvider.bulkInsert
Bundle call ( String method, String arg, Bundle extras)
See call(String, String, Bundle)
final Uri canonicalize ( Uri url)
See canonicalize(Uri)
int delete ( Uri url, String selection, String[] selectionArgs)
See ContentProvider.delete
ContentProvider getLocalContentProvider ()
Get a reference to the ContentProvider that is associated with this client.
String[] getStreamTypes ( Uri url, String mimeTypeFilter)
See ContentProvider.getStreamTypes
String getType ( Uri url)
See ContentProvider.getType
Uri insert ( Uri url, ContentValues initialValues)
See ContentProvider.insert
AssetFileDescriptor openAssetFile ( Uri url, String mode, CancellationSignal signal)
See ContentProvider.openAssetFile .
AssetFileDescriptor openAssetFile ( Uri url, String mode)
See ContentProvider.openAssetFile .
ParcelFileDescriptor openFile ( Uri url, String mode)
See ContentProvider.openFile .
ParcelFileDescriptor openFile ( Uri url, String mode, CancellationSignal signal)
See ContentProvider.openFile .
final AssetFileDescriptor openTypedAssetFileDescriptor ( Uri uri, String mimeType, Bundle opts, CancellationSignal signal)
See ContentProvider.openTypedAssetFile
final AssetFileDescriptor openTypedAssetFileDescriptor ( Uri uri, String mimeType, Bundle opts)
See ContentProvider.openTypedAssetFile
Cursor query ( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder)
See ContentProvider.query
Cursor query ( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)
See ContentProvider.query
boolean release ()
Call this to indicate to the system that the associated ContentProvider is no longer needed by this ContentProviderClient .
final Uri uncanonicalize ( Uri url)
See uncanonicalize(Uri)
int update ( Uri url, ContentValues values, String selection, String[] selectionArgs)
See ContentProvider.update
Protected Methods
void finalize ()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

)">

public ContentProviderResult[] applyBatch ( ArrayList < ContentProviderOperation > operations)

Added in API level 5

See )">ContentProvider.applyBatch

Throws
RemoteException
OperationApplicationException

public int bulkInsert ( Uri url, ContentValues[] initialValues)

Added in API level 5

See ContentProvider.bulkInsert

Throws
RemoteException

public Bundle call ( String method, String arg, Bundle extras)

See call(String, String, Bundle)

Throws
RemoteException

public final Uri canonicalize ( Uri url)

See canonicalize(Uri)

Throws
RemoteException

public int delete ( Uri url, String selection, String[] selectionArgs)

Added in API level 5

See ContentProvider.delete

Throws
RemoteException

public ContentProvider getLocalContentProvider ()

Added in API level 5

Get a reference to the ContentProvider that is associated with this client. If the ContentProvider is running in a different process then null will be returned. This can be used if you know you are running in the same process as a provider, and want to get direct access to its implementation details.

Returns

public String[] getStreamTypes ( Uri url, String mimeTypeFilter)

See ContentProvider.getStreamTypes

Throws
RemoteException

public String getType ( Uri url)

Added in API level 5

See ContentProvider.getType

Throws
RemoteException

public Uri insert ( Uri url, ContentValues initialValues)

Added in API level 5

See ContentProvider.insert

Throws
RemoteException

public AssetFileDescriptor openAssetFile ( Uri url, String mode, CancellationSignal signal)

See ContentProvider.openAssetFile . Note that this does not take care of non-content: URIs such as file:. It is strongly recommended you use the ContentResolver.openAssetFileDescriptor API instead.

Throws
RemoteException
FileNotFoundException

public AssetFileDescriptor openAssetFile ( Uri url, String mode)

Added in API level 5

See ContentProvider.openAssetFile . Note that this does not take care of non-content: URIs such as file:. It is strongly recommended you use the ContentResolver.openAssetFileDescriptor API instead.

Throws
RemoteException
FileNotFoundException

public ParcelFileDescriptor openFile ( Uri url, String mode)

Added in API level 5

See ContentProvider.openFile . Note that this does not take care of non-content: URIs such as file:. It is strongly recommended you use the ContentResolver.openFileDescriptor API instead.

Throws
RemoteException
FileNotFoundException

public ParcelFileDescriptor openFile ( Uri url, String mode, CancellationSignal signal)

See ContentProvider.openFile . Note that this does not take care of non-content: URIs such as file:. It is strongly recommended you use the ContentResolver.openFileDescriptor API instead.

Throws
RemoteException
FileNotFoundException

public final AssetFileDescriptor openTypedAssetFileDescriptor ( Uri uri, String mimeType, Bundle opts, CancellationSignal signal)

See ContentProvider.openTypedAssetFile

Throws
RemoteException
FileNotFoundException

public final AssetFileDescriptor openTypedAssetFileDescriptor ( Uri uri, String mimeType, Bundle opts)

See ContentProvider.openTypedAssetFile

Throws
RemoteException
FileNotFoundException

public Cursor query ( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder)

Added in API level 5

See ContentProvider.query

Throws
RemoteException

public Cursor query ( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)

See ContentProvider.query

Throws
RemoteException

public boolean release ()

Added in API level 5

Call this to indicate to the system that the associated ContentProvider is no longer needed by this ContentProviderClient .

Returns
  • true if this was release, false if it was already released

public final Uri uncanonicalize ( Uri url)

See uncanonicalize(Uri)

Throws
RemoteException

public int update ( Uri url, ContentValues values, String selection, String[] selectionArgs)

Added in API level 5

See ContentProvider.update

Throws
RemoteException

Protected Methods

protected void finalize ()

Added in API level 5

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable ), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable