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

? Examples 		ContentProviderResult[] applyBatch( ArrayList< ContentProviderOperation> operations)
See ContentProvider.applyBatch

? Examples 		int bulkInsert( Uri url, ContentValues[] initialValues)
See ContentProvider.bulkInsert

? Examples 		Bundle call( String method, String arg, Bundle extras)
See call(String, String, Bundle)

? Examples 		int delete( Uri url, String selection, String[] selectionArgs)
See ContentProvider.delete

? Examples 		ContentProvider getLocalContentProvider()
Get a reference to the ContentProvider that is associated with this client.

? Examples 		String[] getStreamTypes( Uri url, String mimeTypeFilter)
See ContentProvider.getStreamTypes

? Examples 		String getType( Uri url)
See ContentProvider.getType

? Examples 		Uri insert( Uri url, ContentValues initialValues)
See ContentProvider.insert

? Examples 		AssetFileDescriptor openAssetFile( Uri url, String mode)
See ContentProvider.openAssetFile.

? Examples 		ParcelFileDescriptor openFile( Uri url, String mode)
See ContentProvider.openFile.

? Examples 		final AssetFileDescriptor openTypedAssetFileDescriptor( Uri uri, String mimeType, Bundle opts)
See ContentProvider.openTypedAssetFile

? Examples 		Cursor query( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder)
See ContentProvider.query

? Examples 		Cursor query( Uri url, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)
See ContentProvider.query

? Examples 		boolean release()
Call this to indicate to the system that the associated ContentProvider is no longer needed by this ContentProviderClient.

? Examples 		int update( Uri url, ContentValues values, String selection, String[] selectionArgs)
See ContentProvider.update
[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)

Added in API level 17

See call(String, String, Bundle)

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

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

Added in API level 11

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)

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 final AssetFileDescriptor openTypedAssetFileDescriptor (Uri uri, String mimeType, Bundle opts)

Added in API level 11

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)

Added in API level 16

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 int update (Uri url, ContentValues values, String selection, String[] selectionArgs)

Added in API level 5

See ContentProvider.update

Throws
RemoteException
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.