Added in API level 8

Summary: Inherited Constants | Ctors | Protected Ctors | Methods | Inherited Methods

MockContentProvider

Kotlin |Java

public class MockContentProvider
extends ContentProvider

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.

Summary

Inherited constants

From interface android.content.ComponentCallbacks2

`int`	`TRIM_MEMORY_BACKGROUND` Level for `onTrimMemory(int)`: the process has gone on to the LRU list.
`int`	`TRIM_MEMORY_COMPLETE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_MODERATE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_CRITICAL` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_LOW` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_RUNNING_MODERATE` This constant was deprecated in API level 35. Apps are not notified of this level since API level 34
`int`	`TRIM_MEMORY_UI_HIDDEN` Level for `onTrimMemory(int)`: the process had been showing a user interface, and is no longer doing so.

Public constructors
`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.

Protected constructors
`MockContentProvider()` A constructor using `MockContext` instance as a Context in it.

Public methods
`ContentProviderResult[]`	`applyBatch(ArrayList<ContentProviderOperation> operations)`
`void`	`attachInfo(Context context, ProviderInfo info)` After being instantiated, this is called to tell the content provider about itself.
`static void`	`attachInfoForTesting(ContentProvider provider, Context context, ProviderInfo providerInfo)` This method was deprecated in API level Baklava. Use a mocking framework like Mockito. New tests should be written using the Android Testing Support Library.
`int`	`bulkInsert(Uri uri, ContentValues[] values)` If you're reluctant to implement this manually, please just call super.bulkInsert().
`int`	`delete(Uri uri, String selection, String[] selectionArgs)` Implement this to handle requests to delete one or more rows.
`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.
`String`	`getTypeAnonymous(Uri uri)` Implement this to handle requests for MIME type of URIs, that does not need to reveal any internal information which should be protected by any permission.
`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.

Inherited methods

From class


        
          android.content.ContentProvider

`ContentProviderResult[]`	`applyBatch(String authority, 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` on each of them.
`ContentProviderResult[]`	`applyBatch(ArrayList<ContentProviderOperation> operations)`
`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)` Override this to handle requests to insert a set of new rows, or the default implementation will iterate over the values and call `insert(Uri, ContentValues)` on each of them.
`Bundle`	`call(String authority, String method, String arg, Bundle extras)` Call a provider-defined method.
`Bundle`	`call(String method, String arg, Bundle extras)`
`Uri`	`canonicalize(Uri url)` Implement this to support canonicalization of URIs that refer to your content provider.
`final ContentProvider.CallingIdentity`	`clearCallingIdentity()` Reset the identity of the incoming IPC on the current thread.
`abstract int`	`delete(Uri uri, String selection, String[] selectionArgs)` Implement this to handle requests to delete one or more rows.
`int`	`delete(Uri uri, Bundle extras)` Implement this to handle requests to delete one or more rows.
`void`	`dump(FileDescriptor fd, PrintWriter writer, String[] args)` Print the Provider's state into the given stream.
`final AttributionSource`	`getCallingAttributionSource()` Gets the attribution source of the calling app.
`final String`	`getCallingAttributionTag()` Return the attribution tag of the caller that initiated the request being processed on the current thread.
`final String`	`getCallingPackage()` Return the package name of the caller that initiated the request being processed on the current thread.
`final String`	`getCallingPackageUnchecked()` Return the package name of the caller that initiated the request being processed on the current thread.
`final Context`	`getContext()` Retrieves the Context this provider is running in.
`final PathPermission[]`	`getPathPermissions()` Return the path-based permissions required for read and/or write access to this content provider.
`final String`	`getReadPermission()` Return the name of the permission required for read-only access to this content provider.
`String[]`	`getStreamTypes(Uri uri, String mimeTypeFilter)` Called by a client to determine the types of data streams that this content provider supports for the given URI.
`abstract String`	`getType(Uri uri)` Implement this to handle requests for the MIME type of the data at the given URI.
`String`	`getTypeAnonymous(Uri uri)` Implement this to handle requests for MIME type of URIs, that does not need to reveal any internal information which should be protected by any permission.
`final String`	`getWritePermission()` Return the name of the permission required for read/write access to this content provider.
`Uri`	`insert(Uri uri, ContentValues values, Bundle extras)` Implement this to handle requests to insert a new row.
`abstract Uri`	`insert(Uri uri, ContentValues values)` Implement this to handle requests to insert a new row.
`boolean`	`isTemporary()` Returns true if this instance is a temporary content provider.
`void`	`onCallingPackageChanged()` Called whenever the value of `getCallingPackage()` changes, giving the provider an opportunity to invalidate any security related caching it may be performing.
`void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running. This method is always called on the application main thread, and must not perform lengthy operations.
`abstract boolean`	`onCreate()` Implement this to initialize your content provider on startup.
`void`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. This method is always called on the application main thread, and must not perform lengthy operations.
`void`	`onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
`AssetFileDescriptor`	`openAssetFile(Uri uri, String mode, CancellationSignal signal)` This is like `openFile(Uri, String)`, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk.
`AssetFileDescriptor`	`openAssetFile(Uri uri, String mode)` This is like `openFile(Uri, String)`, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk.
`ParcelFileDescriptor`	`openFile(Uri uri, String mode, CancellationSignal signal)` Override this to handle requests to open a file blob.
`ParcelFileDescriptor`	`openFile(Uri uri, String mode)` Override this to handle requests to open a file blob.
`final ParcelFileDescriptor`	`openFileHelper(Uri uri, String mode)` Convenience for subclasses that wish to implement `openFile(Uri, String)` by looking up a column named "_data" at the given URI.
`<T> ParcelFileDescriptor`	`openPipeHelper(Uri uri, String mimeType, Bundle opts, T args, PipeDataWriter<T> func)` A helper function for implementing `openTypedAssetFile(Uri, String, Bundle)`, for creating a data pipe and background thread allowing you to stream generated data back to the client.
`AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts, CancellationSignal signal)` Called by a client to open a read-only stream containing data of a particular MIME type.
`AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, 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, Bundle queryArgs, CancellationSignal cancellationSignal)` Implement this to handle query requests where the arguments are packed into a `Bundle`.
`Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)` Implement this to handle query requests from clients with support for cancellation.
`abstract Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)` Implement this to handle query requests from clients.
`boolean`	`refresh(Uri uri, Bundle extras, CancellationSignal cancellationSignal)` Implement this to support refresh of content identified by `uri`.
`final Context`	`requireContext()` Retrieves a Non-Nullable Context this provider is running in, this is intended to be called after `onCreate()`.
`final void`	`restoreCallingIdentity(ContentProvider.CallingIdentity identity)` Restore the identity of the incoming IPC on the current thread back to a previously identity that was returned by `clearCallingIdentity()`.
`final void`	`setPathPermissions(PathPermission[] permissions)` Change the path-based permission required to read and/or write data in the content provider.
`final void`	`setReadPermission(String permission)` Change the permission required to read data from the content provider.
`final void`	`setWritePermission(String permission)` Change the permission required to read and write data in the content provider.
`void`	`shutdown()` Implement this to shut down the ContentProvider instance.
`Uri`	`uncanonicalize(Uri url)` Remove canonicalization from canonical URIs previously returned by `canonicalize(Uri)`.
`int`	`update(Uri uri, ContentValues values, Bundle extras)` Implement this to handle requests to update one or more rows.
`abstract int`	`update(Uri uri, ContentValues values, String selection, String[] selectionArgs)` Implement this to handle requests to update one or more rows.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.content.ComponentCallbacks2


      onTrimMemory(int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.

From interface


        
          android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running.
`abstract void`	`onLowMemory()` This method was deprecated in API level 35. Since API level 14 this is superseded by `ComponentCallbacks2.onTrimMemory`. Since API level 34 this is never called. If you're overriding ComponentCallbacks2#onTrimMemory and your minSdkVersion is greater than API 14, you can provide an empty implementation for this method.

Public constructors

MockContentProvider

Added in API level 8

public MockContentProvider (Context context)

A constructor accepting a Context instance, which is supposed to be the subclasss of MockContext.

Parameters
`context`	`Context`

MockContentProvider

Added in API level 8

public MockContentProvider (Context context, 
                String readPermission, 
                String writePermission, 
                PathPermission[] pathPermissions)

A constructor which initialize four member variables which ContentProvider have internally.

Parameters
`context`	`Context`: A Context object which should be some mock instance (like the instance of `MockContext`).
`readPermission`	`String`: The read permision you want this instance should have in the test, which is available via `ContentProvider.getReadPermission()`.
`writePermission`	`String`: The write permission you want this instance should have in the test, which is available via `ContentProvider.getWritePermission()`.
`pathPermissions`	`PathPermission`: The PathPermissions you want this instance should have in the test, which is available via `ContentProvider.getPathPermissions()`.

Protected constructors

MockContentProvider

Added in API level 8

protected MockContentProvider ()

A constructor using MockContext instance as a Context in it.

Public methods

applyBatch

Added in API level 8

public ContentProviderResult[] applyBatch (ArrayList<ContentProviderOperation> operations)

Parameters
`operations`	`ArrayList`: This value cannot be `null`.

Returns
`ContentProviderResult[]`	This value cannot be `null`.

attachInfo

Added in API level 8

public void attachInfo (Context context, 
                ProviderInfo info)

After being instantiated, this is called to tell the content provider about itself.

Parameters
`context`	`Context`: The context this provider is running in
`info`	`ProviderInfo`: Registered information about this content provider

attachInfoForTesting

Added in Android Baklava
Deprecated in API level Baklava

public static void attachInfoForTesting (ContentProvider provider, 
                Context context, 
                ProviderInfo providerInfo)

This method was deprecated in API level Baklava.
Use a mocking framework like Mockito. New tests should be written using the Android Testing Support Library.

Like attachInfo(android.content.Context, android.content.pm.ProviderInfo), but for use when directly instantiating the provider for testing.

Provided for use by android.test.ProviderTestCase2 and android.test.RenamingDelegatingContext.

Parameters
`provider`	`ContentProvider`
`context`	`Context`
`providerInfo`	`ProviderInfo`

bulkInsert

Added in API level 8

public int bulkInsert (Uri uri, 
                ContentValues[] values)

If you're reluctant to implement this manually, please just call super.bulkInsert().

Parameters
`uri`	`Uri`: The content:// URI of the insertion request. This value cannot be `null`.
`values`	`ContentValues`: An array of sets of column_name/value pairs to add to the database. This must not be `null`.

Returns
`int`	The number of values that were inserted.

delete

Added in API level 8

public int delete (Uri uri, 
                String selection, 
                String[] selectionArgs)

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.

Parameters
`uri`	`Uri`: The full URI to query, including a row ID (if a specific record is requested). This value cannot be `null`.
`selection`	`String`: An optional restriction to apply to rows when deleting. This value may be `null`.
`selectionArgs`	`String`: This value may be `null`.

Returns
`int`	The number of rows affected.

getStreamTypes

Added in API level 11

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

Parameters
`url`	`Uri`: The data in the content provider being queried. This value cannot be `null`.
`mimeTypeFilter`	`String`: The type of data the client desires. May be a pattern, such as / to retrieve all possible data types. This value cannot be `null`.

Returns
`String[]`	Returns `null` if there are no possible data streams for the given mimeTypeFilter. Otherwise returns an array of all available concrete MIME types.

getType

Added in API level 8

public String getType (Uri uri)

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 by default 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.

If your mime type reveals details that should be protected, then you should protect this method by implementing getTypeAnonymous(Uri). Implementing getTypeAnonymous(Uri) ensures your getType(Uri) can be only accessed by caller's having associated readPermission for the URI.

Parameters
`uri`	`Uri`: the URI to query. This value cannot be `null`.

Returns
`String`	a MIME type string, or `null` if there is no type.

getTypeAnonymous

Added in API level 34

public String getTypeAnonymous (Uri uri)

Implement this to handle requests for MIME type of URIs, that does not need to reveal any internal information which should be protected by any permission.

If your mime type reveals details that should be protected, then you should protect those by implementing those in getType(Uri), and in this function, only return types of URIs which can be obtained by anyone without any access. Implementing ths function will make sure getType(Uri) is protected by readPermission. This function by default works as the getType(Uri)

Parameters
`uri`	`Uri`: the URI to query. This value cannot be `null`.

Returns
`String`	a MIME type string, or `null` if type needs to be protected.

insert

Added in API level 8

public Uri insert (Uri uri, 
                ContentValues values)

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.

Parameters
`uri`	`Uri`: The content:// URI of the insertion request. This value cannot be `null`.
`values`	`ContentValues`: A set of column_name/value pairs to add to the database. This value may be `null`.

Returns
`Uri`	The URI for the newly inserted item. This value may be `null`.

onCreate

Added in API level 8

public boolean onCreate ()

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, Bundle, CancellationSignal), 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 SQLiteOpenHelper.getReadableDatabase() or SQLiteOpenHelper.getWritableDatabase() from this method. (Instead, override SQLiteOpenHelper.onOpen(SQLiteDatabase) to initialize the database when it is first opened.)

Returns
`boolean`	true if the provider was successfully loaded, false otherwise

openTypedAssetFile

Added in API level 11

public 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. This is like openAssetFile(android.net.Uri, java.lang.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(android.net.Uri) and, if they match, simply calls openAssetFile(android.net.Uri, java.lang.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.

Parameters
`url`	`Uri`: The data in the content provider being queried. This value cannot be `null`.
`mimeType`	`String`: 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. This value cannot be `null`.
`opts`	`Bundle`: Additional options from the client. The definitions of these are specific to the content provider being called. This value may be `null`.

Returns
`AssetFileDescriptor`	Returns a new AssetFileDescriptor from which the client can read data of the desired type. This value may be `null`.

query

Added in API level 8

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

Implement this to handle query requests from clients.

Apps targeting Build.VERSION_CODES.O or higher should override query(android.net.Uri, java.lang.String[], android.os.Bundle, android.os.CancellationSignal) and provide a stub implementation of this method.

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

 // Guard against SQL injection attacks
 qBuilder.setStrict(true);
 qBuilder.setProjectionMap(MAP_OF_QUERYABLE_COLUMNS);
 qBuilder.setStrictColumns(true);
 qBuilder.setStrictGrammar(true);

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

Parameters
`uri`	`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. This value cannot be `null`.
`projection`	`String`: The list of columns to put into the cursor. If `null` all columns are included.
`selection`	`String`: A selection criteria to apply when filtering rows. If `null` then all rows are included.
`selectionArgs`	`String`: 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. This value may be `null`.
`sortOrder`	`String`: How the rows in the cursor should be sorted. If `null` then the provider is free to define the sort order.

Returns
`Cursor`	a Cursor or `null`.

update

Added in API level 8

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

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.

Parameters
`uri`	`Uri`: The URI to query. This can potentially have a record ID if this is an update request for a specific record. This value cannot be `null`.
`values`	`ContentValues`: A set of column_name/value pairs to update in the database. This value may be `null`.
`selection`	`String`: An optional filter to match rows to update. This value may be `null`.
`selectionArgs`	`String`: This value may be `null`.

Returns
`int`	the number of rows affected.