Package org.robolectric.shadows

Class ShadowContentResolver

java.lang.Object

org.robolectric.shadows.ShadowContentResolver

@Implements(android.content.ContentResolver.class)
public class ShadowContentResolver
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowContentResolver.DeleteStatement	A statement used to delete content in a ContentProvider.
static class	ShadowContentResolver.InsertStatement	A statement used to insert content into a ContentProvider.
static class	ShadowContentResolver.NotifiedUri
static class	ShadowContentResolver.Statement	A statement used to modify content in a ContentProvider.
static class	ShadowContentResolver.Status
static class	ShadowContentResolver.UpdateStatement	A statement used to update content in a ContentProvider.

Constructor Summary

Constructors

Constructor	Description
ShadowContentResolver()

Method Summary

Modifier and Type	Method	Description
protected ContentProviderClient	acquireContentProviderClient(Uri uri)
protected ContentProviderClient	acquireContentProviderClient(String name)
protected IContentProvider	acquireProvider(Uri uri)
protected IContentProvider	acquireProvider(String name)
protected ContentProviderClient	acquireUnstableContentProviderClient(Uri uri)
protected ContentProviderClient	acquireUnstableContentProviderClient(String name)
protected final IContentProvider	acquireUnstableProvider(Uri uri)
protected IContentProvider	acquireUnstableProvider(String name)
protected static void	addPeriodicSync(Account account, String authority, Bundle extras, long pollFrequency)
protected ContentProviderResult[]	applyBatch(String authority, ArrayList<ContentProviderOperation> operations)
protected int	bulkInsert(Uri url, ContentValues[] values)	If a ContentProvider is registered for the given Uri, its ContentProvider.bulkInsert(Uri, ContentValues[]) method will be invoked.
protected Bundle	call(Uri uri, String method, String arg, Bundle extras)
protected static void	cancelSync(Account account, String authority)
void	clearRegisterContentProviderException(Uri uri)	Clears an exception previously set with setRegisterContentProviderException(Uri, RuntimeException).
protected int	delete(Uri url, String where, String[] selectionArgs)	If a ContentProvider is registered for the given Uri, its ContentProvider.delete(Uri, String, String[]) method will be invoked.
Collection<ContentObserver>	getContentObservers(Uri uri)	Returns the content observers registered for updates under the given URI.
List<ContentProviderOperation>	getContentProviderOperations(String authority)	Deprecated.
protected static List<SyncInfo>	getCurrentSyncs()
List<Uri>	getDeletedUris()	Deprecated.
List<ShadowContentResolver.DeleteStatement>	getDeleteStatements()	Deprecated.
List<ShadowContentResolver.InsertStatement>	getInsertStatements()	Deprecated. This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
protected static int	getIsSyncable(Account account, String authority)
protected static boolean	getMasterSyncAutomatically()
List<ShadowContentResolver.NotifiedUri>	getNotifiedUris()	Deprecated.
protected static List<PeriodicSync>	getPeriodicSyncs(Account account, String authority)
protected List<UriPermission>	getPersistedUriPermissions()
static ContentProvider	getProvider(Uri uri)
List<ShadowContentResolver.Statement>	getStatements()	Deprecated. This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
static ShadowContentResolver.Status	getStatus(Account account, String authority)
static ShadowContentResolver.Status	getStatus(Account account, String authority, boolean create)	Retrieve information on the status of the given account.
protected static SyncAdapterType[]	getSyncAdapterTypes()
protected static boolean	getSyncAutomatically(Account account, String authority)
protected String	getType(Uri uri)
List<ShadowContentResolver.UpdateStatement>	getUpdateStatements()	Deprecated. This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
protected Uri	insert(Uri url, ContentValues values)	If a ContentProvider is registered for the given Uri, its ContentProvider.insert(Uri, ContentValues) method will be invoked.
protected static boolean	isSyncActive(Account account, String authority)
protected void	notifyChange(Uri uri, ContentObserver observer)
protected void	notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork)
protected void	notifyChange(Uri uri, ContentObserver observer, int flags)
protected static void	onDbCorruption(String tag, String message, Throwable stacktrace)
protected InputStream	openInputStream(Uri uri)
protected OutputStream	openOutputStream(Uri uri)
protected OutputStream	openOutputStream(Uri uri, String mode)
protected final Cursor	query(Uri uri, String[] projection, Bundle queryArgs, CancellationSignal cancellationSignal)
protected Cursor	query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
protected Cursor	query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)
protected void	registerContentObserver(Uri uri, boolean notifyForDescendents, ContentObserver observer)
protected void	registerContentObserver(Uri uri, boolean notifyForDescendents, ContentObserver observer, int userHandle)
void	registerInputStream(Uri uri, InputStream inputStream)
void	registerInputStreamSupplier(Uri uri, Supplier<InputStream> supplier)
void	registerOutputStream(Uri uri, OutputStream outputStream)
void	registerOutputStreamSupplier(Uri uri, Supplier<OutputStream> supplier)
static void	registerProviderInternal(String authority, ContentProvider provider)	Internal-only method, do not use!
protected void	releasePersistableUriPermission(Uri uri, int modeFlags)
protected static void	removePeriodicSync(Account account, String authority, Bundle extras)
protected static void	requestSync(Account account, String authority, Bundle extras)
static void	reset()
void	setCursor(Uri uri, BaseCursor cursorForUri)	Deprecated. This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
void	setCursor(BaseCursor cursor)	Deprecated. This method affects all calls, and does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
protected static void	setIsSyncable(Account account, String authority, int syncable)
protected static void	setMasterSyncAutomatically(boolean sync)
void	setNextDatabaseIdForInserts(int nextId)	Deprecated. This method affects all calls, and does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)
void	setRegisterContentProviderException(Uri uri, RuntimeException exception)	Makes registerContentObserver(android.net.Uri, boolean, android.database.ContentObserver) throw the specified exception for the specified URI.
static void	setSyncAdapterTypes(SyncAdapterType[] syncAdapterTypes)	Sets the SyncAdapterType array which will be returned by getSyncAdapterTypes().
protected static void	setSyncAutomatically(Account account, String authority, boolean sync)
protected void	takePersistableUriPermission(Uri uri, int modeFlags)
protected void	unregisterContentObserver(ContentObserver observer)
protected int	update(Uri uri, ContentValues values, String where, String[] selectionArgs)	If a ContentProvider is registered for the given Uri, its ContentProvider.update(Uri, ContentValues, String, String[]) method will be invoked.
protected static void	validateSyncExtrasBundle(Bundle extras)

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowContentResolver

public ShadowContentResolver()

Method Details

reset

@Resetter
public static void reset()

registerInputStream

public void registerInputStream(Uri uri,
 InputStream inputStream)

registerInputStreamSupplier

public void registerInputStreamSupplier(Uri uri,
 Supplier<InputStream> supplier)

registerOutputStream

public void registerOutputStream(Uri uri,
 OutputStream outputStream)

registerOutputStreamSupplier

public void registerOutputStreamSupplier(Uri uri,
 Supplier<OutputStream> supplier)

openInputStream

@Implementation
protected InputStream openInputStream(Uri uri)
                               throws FileNotFoundException

Throws:

FileNotFoundException

openOutputStream

@Implementation
protected OutputStream openOutputStream(Uri uri)
                                 throws FileNotFoundException

Throws:

FileNotFoundException

openOutputStream

@Implementation
protected OutputStream openOutputStream(Uri uri,
 String mode)
                                 throws FileNotFoundException

Throws:

FileNotFoundException

insert

@Implementation
protected Uri insert(Uri url,
 ContentValues values)

If a ContentProvider is registered for the given Uri, its ContentProvider.insert(Uri, ContentValues) method will be invoked.

Tests can verify that this method was called using getStatements() or getInsertStatements().

If no appropriate ContentProvider is found, no action will be taken and a Uri including the incremented value set with setNextDatabaseIdForInserts(int) will returned.

update

@Implementation
protected int update(Uri uri,
 ContentValues values,
 String where,
 String[] selectionArgs)

If a ContentProvider is registered for the given Uri, its ContentProvider.update(Uri, ContentValues, String, String[]) method will be invoked.

Tests can verify that this method was called using getStatements() or getUpdateStatements().

Returns:

If no appropriate ContentProvider is found, no action will be taken and 1 will be returned.

query

@Implementation(minSdk=26)
protected final Cursor query(Uri uri,
 String[] projection,
 Bundle queryArgs,
 CancellationSignal cancellationSignal)

query

@Implementation
protected Cursor query(Uri uri,
 String[] projection,
 String selection,
 String[] selectionArgs,
 String sortOrder)

query

@Implementation
protected Cursor query(Uri uri,
 String[] projection,
 String selection,
 String[] selectionArgs,
 String sortOrder,
 CancellationSignal cancellationSignal)

getType

@Implementation
protected String getType(Uri uri)

call

@Implementation
protected Bundle call(Uri uri,
 String method,
 String arg,
 Bundle extras)

acquireContentProviderClient

@Implementation
protected ContentProviderClient acquireContentProviderClient(String name)

acquireContentProviderClient

@Implementation
protected ContentProviderClient acquireContentProviderClient(Uri uri)

acquireUnstableContentProviderClient

@Implementation
protected ContentProviderClient acquireUnstableContentProviderClient(String name)

acquireUnstableContentProviderClient

@Implementation
protected ContentProviderClient acquireUnstableContentProviderClient(Uri uri)

acquireProvider

@Implementation
protected IContentProvider acquireProvider(String name)

acquireProvider

@Implementation
protected IContentProvider acquireProvider(Uri uri)

acquireUnstableProvider

@Implementation
protected IContentProvider acquireUnstableProvider(String name)

acquireUnstableProvider

@Implementation
protected final IContentProvider acquireUnstableProvider(Uri uri)

delete

@Implementation
protected int delete(Uri url,
 String where,
 String[] selectionArgs)

If a ContentProvider is registered for the given Uri, its ContentProvider.delete(Uri, String, String[]) method will be invoked.

Tests can verify that this method was called using getDeleteStatements() or getDeletedUris().

If no appropriate ContentProvider is found, no action will be taken and 1 will be returned.

bulkInsert

@Implementation
protected int bulkInsert(Uri url,
 ContentValues[] values)

If a ContentProvider is registered for the given Uri, its ContentProvider.bulkInsert(Uri, ContentValues[]) method will be invoked.

Tests can verify that this method was called using getStatements() or getInsertStatements().

If no appropriate ContentProvider is found, no action will be taken and the number of rows in values will be returned.

notifyChange

@Implementation(minSdk=24)
protected void notifyChange(Uri uri,
 ContentObserver observer,
 int flags)

notifyChange

@Implementation
protected void notifyChange(Uri uri,
 ContentObserver observer,
 boolean syncToNetwork)

notifyChange

@Implementation
protected void notifyChange(Uri uri,
 ContentObserver observer)

applyBatch

@Implementation
protected ContentProviderResult[] applyBatch(String authority,
 ArrayList<ContentProviderOperation> operations)
                                      throws OperationApplicationException

Throws:

OperationApplicationException

requestSync

@Implementation
protected static void requestSync(Account account,
 String authority,
 Bundle extras)

cancelSync

@Implementation
protected static void cancelSync(Account account,
 String authority)

isSyncActive

@Implementation
protected static boolean isSyncActive(Account account,
 String authority)

getCurrentSyncs

@Implementation
protected static List<SyncInfo> getCurrentSyncs()

setIsSyncable

@Implementation
protected static void setIsSyncable(Account account,
 String authority,
 int syncable)

getIsSyncable

@Implementation
protected static int getIsSyncable(Account account,
 String authority)

getSyncAutomatically

@Implementation
protected static boolean getSyncAutomatically(Account account,
 String authority)

setSyncAutomatically

@Implementation
protected static void setSyncAutomatically(Account account,
 String authority,
 boolean sync)

addPeriodicSync

@Implementation
protected static void addPeriodicSync(Account account,
 String authority,
 Bundle extras,
 long pollFrequency)

removePeriodicSync

@Implementation
protected static void removePeriodicSync(Account account,
 String authority,
 Bundle extras)

getPeriodicSyncs

@Implementation
protected static List<PeriodicSync> getPeriodicSyncs(Account account,
 String authority)

validateSyncExtrasBundle

@Implementation
protected static void validateSyncExtrasBundle(Bundle extras)

setMasterSyncAutomatically

@Implementation
protected static void setMasterSyncAutomatically(boolean sync)

getMasterSyncAutomatically

@Implementation
protected static boolean getMasterSyncAutomatically()

takePersistableUriPermission

@Implementation
protected void takePersistableUriPermission(Uri uri,
 int modeFlags)

releasePersistableUriPermission

@Implementation
protected void releasePersistableUriPermission(Uri uri,
 int modeFlags)

getPersistedUriPermissions

@Implementation
protected List<UriPermission> getPersistedUriPermissions()

getProvider

public static ContentProvider getProvider(Uri uri)

registerProviderInternal

public static void registerProviderInternal(String authority,
 ContentProvider provider)

Internal-only method, do not use!

Instead, use

 ProviderInfo info = new ProviderInfo();
 info.authority = authority;
 Robolectric.buildContentProvider(ContentProvider.class).create(info);
 

getStatus

public static ShadowContentResolver.Status getStatus(Account account,
 String authority)

getStatus

public static ShadowContentResolver.Status getStatus(Account account,
 String authority,
 boolean create)

Retrieve information on the status of the given account.

Parameters:

account - the account

authority - the authority

create - whether to create if no such account is found

Returns:

the account's status

setCursor

@Deprecated
public void setCursor(BaseCursor cursor)

Deprecated.

This method affects all calls, and does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

setCursor

@Deprecated
public void setCursor(Uri uri,
 BaseCursor cursorForUri)

Deprecated.

This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

setNextDatabaseIdForInserts

@Deprecated
public void setNextDatabaseIdForInserts(int nextId)

Deprecated.

This method affects all calls, and does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

getStatements

@Deprecated
public List<ShadowContentResolver.Statement> getStatements()

Deprecated.

This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

Returns the list of ShadowContentResolver.InsertStatements, ShadowContentResolver.UpdateStatements, and ShadowContentResolver.DeleteStatements invoked on this ContentResolver.

Returns:

a list of statements

getInsertStatements

@Deprecated
public List<ShadowContentResolver.InsertStatement> getInsertStatements()

Deprecated.

This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

Returns the list of ShadowContentResolver.InsertStatements for corresponding calls to ContentResolver.insert(Uri, ContentValues) or ContentResolver.bulkInsert(Uri, ContentValues[]).

Returns:

a list of insert statements

getUpdateStatements

@Deprecated
public List<ShadowContentResolver.UpdateStatement> getUpdateStatements()

Deprecated.

This method does not work with ContentResolver.acquireContentProviderClient(android.net.Uri)

Returns the list of ShadowContentResolver.UpdateStatements for corresponding calls to ContentResolver.update(Uri, ContentValues, String, String[]).

Returns:

a list of update statements

getDeletedUris

@Deprecated
public List<Uri> getDeletedUris()

Deprecated.

getDeleteStatements

@Deprecated
public List<ShadowContentResolver.DeleteStatement> getDeleteStatements()

Deprecated.

Returns the list of ShadowContentResolver.DeleteStatements for corresponding calls to ContentResolver.delete(Uri, String, String[]).

Returns:

a list of delete statements

getNotifiedUris

@Deprecated
public List<ShadowContentResolver.NotifiedUri> getNotifiedUris()

Deprecated.

getContentProviderOperations

@Deprecated
public List<ContentProviderOperation> getContentProviderOperations(String authority)

Deprecated.

setRegisterContentProviderException

public void setRegisterContentProviderException(Uri uri,
 RuntimeException exception)

Makes registerContentObserver(android.net.Uri, boolean, android.database.ContentObserver) throw the specified exception for the specified URI.

clearRegisterContentProviderException

public void clearRegisterContentProviderException(Uri uri)

Clears an exception previously set with setRegisterContentProviderException(Uri, RuntimeException).

registerContentObserver

@Implementation
protected void registerContentObserver(Uri uri,
 boolean notifyForDescendents,
 ContentObserver observer)

registerContentObserver

@Implementation
protected void registerContentObserver(Uri uri,
 boolean notifyForDescendents,
 ContentObserver observer,
 int userHandle)

unregisterContentObserver

@Implementation
protected void unregisterContentObserver(ContentObserver observer)

getSyncAdapterTypes

@Implementation
protected static SyncAdapterType[] getSyncAdapterTypes()

setSyncAdapterTypes

public static void setSyncAdapterTypes(SyncAdapterType[] syncAdapterTypes)

Sets the SyncAdapterType array which will be returned by getSyncAdapterTypes().

getContentObservers

public Collection<ContentObserver> getContentObservers(Uri uri)

Returns the content observers registered for updates under the given URI.

Will be empty if no observer is registered.

Parameters:

uri - Given URI

Returns:

The content observers, or null

onDbCorruption

@Implementation(minSdk=29)
protected static void onDbCorruption(String tag,
 String message,
 Throwable stacktrace)