java.lang.Object | ||
↳ | android.content.ContentProvider | |
↳ | android.test.mock.MockContentProvider |
Mock implementation of ContentProvider. All methods are non-functional and throw
UnsupportedOperationException
. Tests can extend this class to
implement behavior needed for tests.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.content.ComponentCallbacks2
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
A constructor accepting a Context instance, which is supposed to be the subclasss of
MockContext . | |||||||||||
A constructor which initialize four member variables which
ContentProvider have internally. |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
A constructor using
MockContext instance as a Context in it. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this to handle requests to perform a batch of operations, or the
default implementation will iterate over the operations and call
apply(ContentProvider, ContentProviderResult[], int) on each of them. | |||||||||||
After being instantiated, this is called to tell the content provider
about itself.
| |||||||||||
If you're reluctant to implement this manually, please just call super.bulkInsert().
| |||||||||||
Implement this to handle requests to delete one or more rows.
| |||||||||||
Called by a client to determine the types of data streams that this
content provider supports for the given URI.
| |||||||||||
Implement this to handle requests for the MIME type of the data at the
given URI.
| |||||||||||
Implement this to handle requests to insert a new row.
| |||||||||||
Implement this to initialize your content provider on startup.
| |||||||||||
Called by a client to open a read-only stream containing data of a
particular MIME type.
| |||||||||||
Implement this to handle query requests from clients.
| |||||||||||
Implement this to handle requests to update one or more rows.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.content.ContentProvider
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.content.ComponentCallbacks
| |||||||||||
From interface
android.content.ComponentCallbacks2
|
A constructor accepting a Context instance, which is supposed to be the subclasss of
MockContext
.
A constructor which initialize four member variables which
ContentProvider
have internally.
context | A Context object which should be some mock instance (like the
instance of MockContext ). |
---|---|
readPermission | The read permision you want this instance should have in the
test, which is available via getReadPermission() . |
writePermission | The write permission you want this instance should have
in the test, which is available via getWritePermission() . |
pathPermissions | The PathPermissions you want this instance should have
in the test, which is available via getPathPermissions() .
|
A constructor using MockContext
instance as a Context in it.
Override this to handle requests to perform a batch of operations, or the
default implementation will iterate over the operations and call
apply(ContentProvider, ContentProviderResult[], int)
on each of them.
If all calls to apply(ContentProvider, ContentProviderResult[], int)
succeed
then a ContentProviderResult
array with as many
elements as there were operations will be returned. If any of the calls
fail, it is up to the implementation how many of the others take effect.
This method can be called from multiple threads, as described in
Processes
and Threads.
operations | the operations to apply |
---|
After being instantiated, this is called to tell the content provider about itself.
context | The context this provider is running in |
---|---|
info | Registered information about this content provider |
If you're reluctant to implement this manually, please just call super.bulkInsert().
uri | The content:// URI of the insertion request. |
---|---|
values | An array of sets of column_name/value pairs to add to the database.
This must not be null . |
Implement this to handle requests to delete one or more rows.
The implementation should apply the selection clause when performing
deletion, allowing the operation to affect multiple rows in a directory.
As a courtesy, call notifyChange()
after deleting.
This method can be called from multiple threads, as described in
Processes
and Threads.
The implementation is responsible for parsing out a row ID at the end
of the URI, if a specific row is being deleted. That is, the client would
pass in content://contacts/people/22
and the implementation is
responsible for parsing the record number (22) when creating a SQL statement.
uri | The full URI to query, including a row ID (if a specific record is requested). |
---|---|
selection | An optional restriction to apply to rows when deleting. |
Called by a client to determine the types of data streams that this
content provider supports for the given URI. The default implementation
returns null
, meaning no types. If your content provider stores data
of a particular type, return that MIME type if it matches the given
mimeTypeFilter. If it can perform type conversions, return an array
of all supported MIME types that match mimeTypeFilter.
url | The data in the content provider being queried. |
---|---|
mimeTypeFilter | The type of data the client desires. May be a pattern, such as */* to retrieve all possible data types. |
null
if there are no possible data streams for the
given mimeTypeFilter. Otherwise returns an array of all available
concrete MIME types.Implement this to handle requests for the MIME type of the data at the
given URI. The returned MIME type should start with
vnd.android.cursor.item
for a single record,
or vnd.android.cursor.dir/
for multiple items.
This method can be called from multiple threads, as described in
Processes
and Threads.
Note that there are no permissions needed for an application to access this information; if your content provider requires read and/or write permissions, or is not exported, all applications can still call this method regardless of their access permissions. This allows them to retrieve the MIME type for a URI when dispatching intents.
uri | the URI to query. |
---|
null
if there is no type.
Implement this to handle requests to insert a new row.
As a courtesy, call notifyChange()
after inserting.
This method can be called from multiple threads, as described in
Processes
and Threads.
uri | The content:// URI of the insertion request. This must not be null . |
---|---|
values | A set of column_name/value pairs to add to the database.
This must not be null . |
Implement this to initialize your content provider on startup. This method is called for all registered content providers on the application main thread at application launch time. It must not perform lengthy operations, or application startup will be delayed.
You should defer nontrivial initialization (such as opening,
upgrading, and scanning databases) until the content provider is used
(via query(Uri, String[], String, String[], String)
, insert(Uri, ContentValues)
, etc). Deferred initialization
keeps application startup fast, avoids unnecessary work if the provider
turns out not to be needed, and stops database errors (such as a full
disk) from halting application launch.
If you use SQLite, SQLiteOpenHelper
is a helpful utility class that makes it easy to manage databases,
and will automatically defer opening until first use. If you do use
SQLiteOpenHelper, make sure to avoid calling
getReadableDatabase()
or
getWritableDatabase()
from this method. (Instead, override
onOpen(SQLiteDatabase)
to initialize the
database when it is first opened.)
Called by a client to open a read-only stream containing data of a
particular MIME type. This is like openAssetFile(Uri, String)
,
except the file can only be read-only and the content provider may
perform data conversions to generate data of the desired type.
The default implementation compares the given mimeType against the
result of getType(Uri)
and, if they match, simply calls
openAssetFile(Uri, String)
.
See ClipData
for examples of the use and implementation
of this method.
The returned AssetFileDescriptor can be a pipe or socket pair to enable streaming of data.
For better interoperability with other applications, it is recommended
that for any URIs that can be opened, you also support queries on them
containing at least the columns specified by OpenableColumns
.
You may also want to support other common columns if you have additional meta-data
to supply, such as DATE_ADDED
in MediaStore.MediaColumns
.
url | The data in the content provider being queried. |
---|---|
mimeType | The type of data the client desires. May be a pattern, such as */*, if the caller does not have specific type requirements; in this case the content provider will pick its best type matching the pattern. |
opts | Additional options from the client. The definitions of these are specific to the content provider being called. |
Implement this to handle query requests from clients. This method can be called from multiple threads, as described in Processes and Threads.
Example client call:
// Request a specific record. Cursor managedCursor = managedQuery( ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2), projection, // Which columns to return. null, // WHERE clause. null, // WHERE clause value substitution People.NAME + " ASC"); // Sort order.Example implementation:
// SQLiteQueryBuilder is a helper class that creates the // proper SQL syntax for us. SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder(); // Set the table we're querying. qBuilder.setTables(DATABASE_TABLE_NAME); // If the query ends in a specific record number, we're // being asked for a specific record, so set the // WHERE clause in our query. if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){ qBuilder.appendWhere("_id=" + uri.getPathLeafId()); } // Make the query. Cursor c = qBuilder.query(mDb, projection, selection, selectionArgs, groupBy, having, sortOrder); c.setNotificationUri(getContext().getContentResolver(), uri); return c;
uri | The URI to query. This will be the full URI sent by the client; if the client is requesting a specific record, the URI will end in a record number that the implementation should parse and add to a WHERE or HAVING clause, specifying that _id value. |
---|---|
projection | The list of columns to put into the cursor. If
null all columns are included. |
selection | A selection criteria to apply when filtering rows.
If null then all rows are included. |
selectionArgs | You may include ?s in selection, which will be replaced by the values from selectionArgs, in order that they appear in the selection. The values will be bound as Strings. |
sortOrder | How the rows in the cursor should be sorted.
If null then the provider is free to define the sort order. |
null
.
Implement this to handle requests to update one or more rows.
The implementation should update all rows matching the selection
to set the columns according to the provided values map.
As a courtesy, call notifyChange()
after updating.
This method can be called from multiple threads, as described in
Processes
and Threads.
uri | The URI to query. This can potentially have a record ID if this is an update request for a specific record. |
---|---|
values | A set of column_name/value pairs to update in the database.
This must not be null . |
selection | An optional filter to match rows to update. |