Android - An Open Handset Alliance Project

android.content
public abstract class

android.content.ContentResolver

java.lang.Object
	android.content.ContentResolver

This class provides applications access to the content model.

Summary

Constants

		Value
String	SCHEME_ANDROID_RESOURCE	"android.resource"
String	SCHEME_CONTENT	"content"
String	SCHEME_FILE	"file"
String	SYNC_EXTRAS_ACCOUNT	"account"
String	SYNC_EXTRAS_EXPEDITED	"expedited"

Public Constructors

ContentResolver(Context context)

Public Methods

final	int	bulkInsert(Uri url, ContentValues[] values)
		Inserts multiple rows into a table at the given URL.
	void	cancelSync()
final	int	delete(Uri url, String where, String[] selectionArgs)
		Deletes row(s) specified by a content URI.
final	String	getDataFilePath(Uri url)
		DO NOT USE THIS FUNCTION!! Someone added this, and they shouldn't have.
final	IContentProvider	getProvider(Uri uri)
		Returns the content provider for the given content URI..
final	IContentProvider	getProviderByName(String name)
		Returns the content provider for the given name.
	String	getSyncMoreStatusText()
	String	getSyncStatusText()
	String	getSyncingAccount()
final	String	getType(Uri url)
		Return the MIME type of the given content URL.
final	Uri	insert(Uri url, ContentValues values)
		Inserts a row into a table at the given URL.
	void	notifyChange(Uri uri, ContentObserver observer)
		Notify registered observers that a row was updated.
	void	notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork)
		Notify registered observers that a row was updated.
final	ParcelFileDescriptor	openFileDescriptor(Uri uri, String mode)
		Open a raw file descriptor to access data under a "content:" URI.
final	InputStream	openInputStream(Uri uri)
		Open a stream on to the content associated with a content URI.
final	OutputStream	openOutputStream(Uri uri)
		Open a stream on to the content associated with a content URI.
final	Cursor	query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
		Query the given URI, returning a Cursor over the result set.
final	void	registerContentObserver(Uri uri, boolean notifyForDescendents, ContentObserver observer)
		Register an observer class that gets callbacks when data identified by a given content URI changes.
	void	registerSyncObserver(SyncObserver observer)
		Register an observer of sync progress.
	void	startSync(Uri uri, Map extras)
		Start an asynchronous sync operation.
final	void	unregisterContentObserver(ContentObserver observer)
		Unregisters a change observer.
	void	unregisterSyncObserver(SyncObserver observer)
		Unregister an observer of sync progress.
final	int	update(Uri uri, ContentValues values, String where, String[] selectionArgs)
		Update row(s) in a content URI.

Protected Methods

abstract				IContentProvider	getProviderByName(Context context, String name)
abstract				void	removeProvider(IContentProvider provider)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Constants

public static final String SCHEME_ANDROID_RESOURCE

Constant Value: "android.resource"

public static final String SCHEME_CONTENT

Constant Value: "content"

public static final String SCHEME_FILE

Constant Value: "file"

public static final String SYNC_EXTRAS_ACCOUNT

Constant Value: "account"

public static final String SYNC_EXTRAS_EXPEDITED

Constant Value: "expedited"

Public Constructors

public ContentResolver(Context context)

Public Methods

public final int bulkInsert(Uri url, ContentValues[] values)

Inserts multiple rows into a table at the given URL. If the content provider supports transactions all of the insertions will be atomic.

Parameters

url	The URL of the table to insert into.
values	The initial values for the newly inserted rows. The key is the column name for the field. Passing null will create an empty row.

Returns

the number of newly created rows.

public void cancelSync()

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

Deletes row(s) specified by a content URI. If the content provider supports transactions, the deletion will be atomic.

Parameters

url	The URL of the row to delete.
where	A filter to apply to rows before deleting, formatted as an SQL WHERE clause (excluding the WHERE itself).

Returns

The number of rows deleted.

public final String getDataFilePath(Uri url)

DO NOT USE THIS FUNCTION!! Someone added this, and they shouldn't have. You do not have direct access to files inside of a content provider. Don't touch this. Go away.

Return the path to the content associated with a content URL. If there is no data associated with the URL, null is returned.

Parameters

url	The desired content URL.

Returns

Path

public final IContentProvider getProvider(Uri uri)

Returns the content provider for the given content URI..

Parameters

uri	The URI to a content provider

Returns

The ContentProvider for the given URI, or null if no content provider is found.

public final IContentProvider getProviderByName(String name)

Returns the content provider for the given name.

Parameters

name	The name of a content provider

Returns

The ContentProvider for the given name, or null if no content provider is found.

public String getSyncMoreStatusText()

public String getSyncStatusText()

public String getSyncingAccount()

public final String getType(Uri url)

Return the MIME type of the given content URL.

Parameters

url	A Uri identifying content (either a list or specific type), using the content:// scheme.

Returns

A MIME type for the content, or null if the URL is invalid or the type is unknown

public final Uri insert(Uri url, ContentValues values)

Inserts a row into a table at the given URL. If the content provider supports transactions the insertion will be atomic.

Parameters

url	The URL of the table to insert into.
values	The initial values for the newly inserted row. The key is the column name for the field. Passing null will create an empty row.

Returns

the URL of the newly created row.

public void notifyChange(Uri uri, ContentObserver observer)

Notify registered observers that a row was updated. To register, call registerContentObserver(). By default, CursorAdapter objects will get this notification.

Parameters

observer	The observer that originated the change, may be `null`

public void notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork)

Notify registered observers that a row was updated. To register, call registerContentObserver(). By default, CursorAdapter objects will get this notification.

Parameters

observer	The observer that originated the change, may be `null`
syncToNetwork	If true, attempt to sync the change to the network.

public final ParcelFileDescriptor openFileDescriptor(Uri uri, String mode)

Open a raw file descriptor to access data under a "content:" URI. This interacts with the underlying openFile(Uri, String) ContentProvider.openFile()} method of the provider associated with the given URI, to retrieve any file stored there.

Accepts the following URI schemes:

content (SCHEME_CONTENT)

Parameters

uri	The desired URI to open.
mode	The file mode to use, as per ContentProvider.openFile.

Returns

Returns a new ParcelFileDescriptor pointing to the file. You own this descriptor and are responsible for closing it when done.

Throws

FileNotFoundException	Throws FileNotFoundException of no file exists under the URI or the mode is invalid.

public final InputStream openInputStream(Uri uri)

Open a stream on to the content associated with a content URI. If there is no data associated with the URI, FileNotFoundException is thrown.

Accepts the following URI schemes:

content (SCHEME_CONTENT)
android.resource (SCHEME_ANDROID_RESOURCE)
file (SCHEME_FILE)

Parameters

uri	The desired "content:" URI.

Returns

InputStream

Throws

FileNotFoundException	if the provided URI could not be opened.

public final OutputStream openOutputStream(Uri uri)

Open a stream on to the content associated with a content URI. If there is no data associated with the URI, FileNotFoundException is thrown.

Accepts the following URI schemes:

content (SCHEME_CONTENT)

Parameters

uri	The desired "content:" URI.

Returns

OutputStream

Throws

FileNotFoundException

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

Query the given URI, returning a Cursor over the result set.

Parameters

uri	The URI, using the content:// scheme, for the content to retrieve.
projection	A list of which columns to return. Passing null will return all columns, which is discouraged to prevent reading data from storage that isn't going to be used.
selection	A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI.
selectionArgs	You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings.
sortOrder	How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

Returns

A Cursor object, which is positioned before the first entry

public final void registerContentObserver(Uri uri, boolean notifyForDescendents, ContentObserver observer)

Parameters

uri	The URI to watch for changes. This can be a specific row URI, or a base URI for a whole class of content.
notifyForDescendents	If `true` changes to URIs beginning with `uri` will also cause notifications to be sent. If `false` only changes to the exact URI specified by uri will cause notifications to be sent. If true, than any URI values at or below the specified URI will also trigger a match.
observer	The object that receives callbacks when changes occur.

public void registerSyncObserver(SyncObserver observer)

Parameters

observer	the observer to register.

public void startSync(Uri uri, Map extras)

Start an asynchronous sync operation. If you want to monitor the progress of the sync you may register a SyncObvserver.

Parameters

uri	the uri of the provider to sync or null to sync all providers.
extras	any extras to pass to the SyncAdapter.

public final void unregisterContentObserver(ContentObserver observer)

Unregisters a change observer.

Parameters

observer	The previously registered observer that is no longer needed.

public void unregisterSyncObserver(SyncObserver observer)

Unregister an observer of sync progress.

Parameters

observer	the observer to unregister.

public final int update(Uri uri, ContentValues values, String where, String[] selectionArgs)

Update row(s) in a content URI. If the content provider supports transactions the update will be atomic.

Parameters

uri	The URI to modify.
values	The new field values. The key is the column name for the field. A null value will remove an existing field value.
where	A filter to apply to rows before deleting, formatted as an SQL WHERE clause (excluding the WHERE itself).

Returns

the URL of the newly created row

Throws

NullPointerException	if uri or values are null


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.content.ContentResolver

Summary

Constants

Public Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Details

Constants

public static final String SCHEME_ANDROID_RESOURCE

public static final String SCHEME_CONTENT

public static final String SCHEME_FILE

public static final String SYNC_EXTRAS_ACCOUNT

public static final String SYNC_EXTRAS_EXPEDITED

Public Constructors

public ContentResolver(Context context)

Public Methods

public final int bulkInsert(Uri url, ContentValues[] values)

Parameters

Returns

public void cancelSync()

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

Parameters

Returns

public final String getDataFilePath(Uri url)

Parameters

Returns

public final IContentProvider getProvider(Uri uri)

Parameters

Returns

public final IContentProvider getProviderByName(String name)

Parameters

Returns

public String getSyncMoreStatusText()

public String getSyncStatusText()

public String getSyncingAccount()

public final String getType(Uri url)

Parameters

Returns

public final Uri insert(Uri url, ContentValues values)

Parameters

Returns

public void notifyChange(Uri uri, ContentObserver observer)

Parameters

public void notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork)

Parameters

public final ParcelFileDescriptor openFileDescriptor(Uri uri, String mode)

Accepts the following URI schemes:

Parameters

Returns

Throws

public final InputStream openInputStream(Uri uri)

Accepts the following URI schemes:

Parameters

Returns

Throws

public final OutputStream openOutputStream(Uri uri)

Accepts the following URI schemes:

Parameters

Returns

Throws

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

Parameters

Returns

See Also

public final void registerContentObserver(Uri uri, boolean notifyForDescendents, ContentObserver observer)

Parameters

See Also

public void registerSyncObserver(SyncObserver observer)

Parameters

public void startSync(Uri uri, Map extras)

Parameters

public final void unregisterContentObserver(ContentObserver observer)

Parameters

See Also

public void unregisterSyncObserver(SyncObserver observer)

Parameters