public class MockContentProvider extends ContentProvider
UnsupportedOperationException
. Tests can extend this class to
implement behavior needed for tests.ContentProvider.PipeDataWriter<T>
TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN
Modifier | Constructor and Description |
---|---|
protected |
MockContentProvider()
A constructor using
MockContext instance as a Context in it. |
|
MockContentProvider(Context context)
A constructor accepting a Context instance, which is supposed to be the subclasss of
MockContext . |
|
MockContentProvider(Context context,
String readPermission,
String writePermission,
PathPermission[] pathPermissions)
A constructor which initialize four member variables which
ContentProvider have internally. |
Modifier and Type | Method and Description |
---|---|
ContentProviderResult[] |
applyBatch(ArrayList<ContentProviderOperation> operations)
Override this to handle requests to perform a batch of operations, or the
default implementation will iterate over the operations and call
ContentProviderOperation.apply(android.content.ContentProvider, android.content.ContentProviderResult[], int) on each of them. |
void |
attachInfo(Context context,
ProviderInfo info)
After being instantiated, this is called to tell the content provider
about itself.
|
int |
bulkInsert(Uri uri,
ContentValues[] values)
If you're reluctant to implement this manually, please just call super.bulkInsert().
|
Bundle |
call(String method,
String request,
Bundle args)
Call a provider-defined method.
|
int |
delete(Uri uri,
String selection,
String[] selectionArgs)
Implement this to handle requests to delete one or more rows.
|
IContentProvider |
getIContentProvider()
Returns IContentProvider which calls back same methods in this class.
|
String[] |
getStreamTypes(Uri url,
String mimeTypeFilter)
Called by a client to determine the types of data streams that this
content provider supports for the given URI.
|
String |
getType(Uri uri)
Implement this to handle requests for the MIME type of the data at the
given URI.
|
Uri |
insert(Uri uri,
ContentValues values)
Implement this to handle requests to insert a new row.
|
boolean |
onCreate()
Implement this to initialize your content provider on startup.
|
AssetFileDescriptor |
openTypedAssetFile(Uri url,
String mimeType,
Bundle opts)
Called by a client to open a read-only stream containing data of a
particular MIME type.
|
Cursor |
query(Uri uri,
String[] projection,
String selection,
String[] selectionArgs,
String sortOrder)
Implement this to handle query requests from clients.
|
int |
update(Uri uri,
ContentValues values,
String selection,
String[] selectionArgs)
Implement this to handle requests to update one or more rows.
|
attachInfoForTesting, canonicalize, coerceToLocalContentProvider, dump, enforceReadPermissionInner, enforceWritePermissionInner, getAppOpsManager, getAuthorityWithoutUserId, getCallingPackage, getContext, getPathPermissions, getReadPermission, getUriWithoutUserId, getUserIdFromAuthority, getUserIdFromAuthority, getUserIdFromUri, getUserIdFromUri, getWritePermission, isTemporary, matchesOurAuthorities, maybeAddUserId, onConfigurationChanged, onLowMemory, onTrimMemory, openAssetFile, openAssetFile, openFile, openFile, openFileHelper, openPipeHelper, openTypedAssetFile, query, rejectInsert, setAppOps, setAuthorities, setPathPermissions, setReadPermission, setWritePermission, shutdown, uncanonicalize, uriHasUserId
protected MockContentProvider()
MockContext
instance as a Context in it.public MockContentProvider(Context context)
MockContext
.public MockContentProvider(Context context, String readPermission, String writePermission, PathPermission[] pathPermissions)
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 ContentProvider.getReadPermission()
.writePermission
- The write permission you want this instance should have
in the test, which is available via ContentProvider.getWritePermission()
.pathPermissions
- The PathPermissions you want this instance should have
in the test, which is available via ContentProvider.getPathPermissions()
.public int delete(Uri uri, String selection, String[] selectionArgs)
ContentProvider
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.
delete
in class ContentProvider
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.public String getType(Uri uri)
ContentProvider
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.
getType
in class ContentProvider
uri
- the URI to query.null
if there is no type.public Uri insert(Uri uri, ContentValues values)
ContentProvider
notifyChange()
after inserting.
This method can be called from multiple threads, as described in
Processes
and Threads.insert
in class ContentProvider
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
.public boolean onCreate()
ContentProvider
You should defer nontrivial initialization (such as opening,
upgrading, and scanning databases) until the content provider is used
(via ContentProvider.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String)
, ContentProvider.insert(android.net.Uri, android.content.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
SQLiteOpenHelper.getReadableDatabase()
or
SQLiteOpenHelper.getWritableDatabase()
from this method. (Instead, override
SQLiteOpenHelper.onOpen(android.database.sqlite.SQLiteDatabase)
to initialize the
database when it is first opened.)
onCreate
in class ContentProvider
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
ContentProvider
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;
query
in class ContentProvider
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
.public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
ContentProvider
notifyChange()
after updating.
This method can be called from multiple threads, as described in
Processes
and Threads.update
in class ContentProvider
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.public int bulkInsert(Uri uri, ContentValues[] values)
bulkInsert
in class ContentProvider
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
.public void attachInfo(Context context, ProviderInfo info)
ContentProvider
attachInfo
in class ContentProvider
context
- The context this provider is running ininfo
- Registered information about this content providerpublic ContentProviderResult[] applyBatch(ArrayList<ContentProviderOperation> operations)
ContentProvider
ContentProviderOperation.apply(android.content.ContentProvider, android.content.ContentProviderResult[], int)
on each of them.
If all calls to ContentProviderOperation.apply(android.content.ContentProvider, android.content.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.applyBatch
in class ContentProvider
operations
- the operations to applyContentProviderOperation.apply(android.content.ContentProvider, android.content.ContentProviderResult[], int)
public Bundle call(String method, String request, Bundle args)
ContentProvider
WARNING: The framework does no permission checking on this entry into the content provider besides the basic ability for the application to get access to the provider at all. For example, it has no idea whether the call being executed may read or write data in the provider, so can't enforce those individual permissions. Any implementation of this method must do its own permission checks on incoming calls to make sure they are allowed.
call
in class ContentProvider
method
- method name to call. Opaque to framework, but should not be null
.request
- provider-defined String argument. May be null
.args
- provider-defined Bundle argument. May be null
.null
, which is also
the default for providers which don't implement any call methods.public String[] getStreamTypes(Uri url, String mimeTypeFilter)
ContentProvider
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.getStreamTypes
in class ContentProvider
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.ContentProvider.getType(Uri)
,
ContentProvider.openTypedAssetFile(Uri, String, Bundle)
,
ClipDescription.compareMimeTypes(String, String)
public AssetFileDescriptor openTypedAssetFile(Uri url, String mimeType, Bundle opts)
ContentProvider
ContentProvider.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 ContentProvider.getType(Uri)
and, if they match, simply calls
ContentProvider.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 MediaStore.MediaColumns.DATE_ADDED
in MediaStore.MediaColumns
.
openTypedAssetFile
in class ContentProvider
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.ContentProvider.getStreamTypes(Uri, String)
,
ContentProvider.openAssetFile(Uri, String)
,
ClipDescription.compareMimeTypes(String, String)
public final IContentProvider getIContentProvider()
getIContentProvider
in class ContentProvider