Skip to content

Most visited

Recently visited

navigation
Added in API level 5

ContentProviderClient

public class ContentProviderClient
extends Object

java.lang.Object
   ↳ android.content.ContentProviderClient


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.

Inherited methods

From class java.lang.Object

Public methods

bulkInsert

Added in API level 5
int bulkInsert (Uri url, 
                ContentValues[] initialValues)

See ContentProvider.bulkInsert

Parameters
url Uri
initialValues ContentValues
Returns
int
Throws
RemoteException

call

Added in API level 17
Bundle call (String method, 
                String arg, 
                Bundle extras)

See call(String, String, Bundle)

Parameters
method String
arg String
extras Bundle
Returns
Bundle
Throws
RemoteException

canonicalize

Added in API level 19
Uri canonicalize (Uri url)

See canonicalize(Uri)

Parameters
url Uri
Returns
Uri
Throws
RemoteException

delete

Added in API level 5
int delete (Uri url, 
                String selection, 
                String[] selectionArgs)

See ContentProvider.delete

Parameters
url Uri
selection String
selectionArgs String
Returns
int
Throws
RemoteException

getLocalContentProvider

Added in API level 5
ContentProvider getLocalContentProvider ()

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
ContentProvider If the associated ContentProvider is local, returns it. Otherwise returns null.

getStreamTypes

Added in API level 11
String[] getStreamTypes (Uri url, 
                String mimeTypeFilter)

See ContentProvider.getStreamTypes

Parameters
url Uri
mimeTypeFilter String
Returns
String[]
Throws
RemoteException

getType

Added in API level 5
String getType (Uri url)

See ContentProvider.getType

Parameters
url Uri
Returns
String
Throws
RemoteException

insert

Added in API level 5
Uri insert (Uri url, 
                ContentValues initialValues)

See ContentProvider.insert

Parameters
url Uri
initialValues ContentValues
Returns
Uri
Throws
RemoteException

openAssetFile

Added in API level 19
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.

Parameters
url Uri
mode String
signal CancellationSignal
Returns
AssetFileDescriptor
Throws
RemoteException
FileNotFoundException

openAssetFile

Added in API level 5
AssetFileDescriptor openAssetFile (Uri url, 
                String mode)

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.

Parameters
url Uri
mode String
Returns
AssetFileDescriptor
Throws
RemoteException
FileNotFoundException

openFile

Added in API level 5
ParcelFileDescriptor openFile (Uri url, 
                String mode)

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.

Parameters
url Uri
mode String
Returns
ParcelFileDescriptor
Throws
RemoteException
FileNotFoundException

openFile

Added in API level 19
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.

Parameters
url Uri
mode String
signal CancellationSignal
Returns
ParcelFileDescriptor
Throws
RemoteException
FileNotFoundException

openTypedAssetFileDescriptor

Added in API level 19
AssetFileDescriptor openTypedAssetFileDescriptor (Uri uri, 
                String mimeType, 
                Bundle opts, 
                CancellationSignal signal)

See ContentProvider.openTypedAssetFile

Parameters
uri Uri
mimeType String
opts Bundle
signal CancellationSignal
Returns
AssetFileDescriptor
Throws
RemoteException
FileNotFoundException

openTypedAssetFileDescriptor

Added in API level 11
AssetFileDescriptor openTypedAssetFileDescriptor (Uri uri, 
                String mimeType, 
                Bundle opts)

See ContentProvider.openTypedAssetFile

Parameters
uri Uri
mimeType String
opts Bundle
Returns
AssetFileDescriptor
Throws
RemoteException
FileNotFoundException

query

Added in API level 5
Cursor query (Uri url, 
                String[] projection, 
                String selection, 
                String[] selectionArgs, 
                String sortOrder)

See ContentProvider.query

Parameters
url Uri
projection String
selection String
selectionArgs String
sortOrder String
Returns
Cursor
Throws
RemoteException

query

Added in API level 16
Cursor query (Uri url, 
                String[] projection, 
                String selection, 
                String[] selectionArgs, 
                String sortOrder, 
                CancellationSignal cancellationSignal)

See ContentProvider.query

Parameters
url Uri
projection String
selection String
selectionArgs String
sortOrder String
cancellationSignal CancellationSignal
Returns
Cursor
Throws
RemoteException

release

Added in API level 5
boolean release ()

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

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

uncanonicalize

Added in API level 19
Uri uncanonicalize (Uri url)

See uncanonicalize(Uri)

Parameters
url Uri
Returns
Uri
Throws
RemoteException

update

Added in API level 5
int update (Uri url, 
                ContentValues values, 
                String selection, 
                String[] selectionArgs)

See ContentProvider.update

Parameters
url Uri
values ContentValues
selection String
selectionArgs String
Returns
int
Throws
RemoteException

Protected methods

finalize

Added in API level 5
void finalize ()

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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.