Skip to content

Most visited

Recently visited

navigation
Added in API level 5

ContentProviderClient

public class ContentProviderClient
extends Object implements AutoCloseable

java.lang.Object
   ↳ android.content.ContentProviderClient


The public interface object used to interact with a specific ContentProvider.

Instances can be obtained by calling acquireContentProviderClient(Uri) or acquireUnstableContentProviderClient(Uri). Instances must be released using close() in order to indicate to the system that the underlying 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 close() 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)

void close()

Closes this client connection, indicating to the system that the underlying ContentProvider is no longer needed.

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, CancellationSignal signal)

See ContentProvider.openFile.

ParcelFileDescriptor openFile(Uri url, String mode)

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()

This method was deprecated in API level 24. replaced by close().

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()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class java.lang.Object
From interface java.lang.AutoCloseable

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

close

Added in API level 24
void close ()

Closes this client connection, indicating to the system that the underlying ContentProvider is no longer needed.

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 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

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

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 ()

This method was deprecated in API level 24.
replaced by close().

Returns
boolean

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 ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the JavaTM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

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.