Skip to content

Most visited

Recently visited

navigation

IdlingRegistry

public final class IdlingRegistry
extends Object

java.lang.Object
   ↳ android.support.test.espresso.IdlingRegistry


Handles registering and unregistering of IdlingResources with Espresso from within your application code.

These resources are required by Espresso to provide synchronisation against your application code. All registered resources with this registry will be automatically synchronized against for each Espresso interaction.

This registry along with IdlingResource interface are bundled together in a small light weight module so that it can be pulled in as a dependency of the App under test with close to no overhead.

Summary

Public methods

static IdlingRegistry getInstance()

Returns a singleton instance of this IdlingRegistry that should be globally used for registering and unregistering IdlingResources

Collection<Looper> getLoopers()
Collection<IdlingResource> getResources()

Returns a set of all currently registered IdlingResources.

boolean register(IdlingResource... idlingResources)

Registers one or more IdlingResources.

void registerLooperAsIdlingResource(Looper looper)

Registers a Looper for idle checking with the framework.

boolean unregister(IdlingResource... idlingResources)

Unregisters one or more IdlingResources.

Inherited methods

From class java.lang.Object

Public methods

getInstance

IdlingRegistry getInstance ()

Returns a singleton instance of this IdlingRegistry that should be globally used for registering and unregistering IdlingResources

Returns
IdlingRegistry

getLoopers

Collection<Looper> getLoopers ()

Returns
Collection<Looper> a set of all currently registered Loopers.

getResources

Collection<IdlingResource> getResources ()

Returns a set of all currently registered IdlingResources.

Returns
Collection<IdlingResource>

register

boolean register (IdlingResource... idlingResources)

Registers one or more IdlingResources. When registering more than one resource, ensure that each has a unique name returned from getName()

Parameters
idlingResources IdlingResource

Returns
boolean true if at least one resource was successfully added to the registry

registerLooperAsIdlingResource

void registerLooperAsIdlingResource (Looper looper)

Registers a Looper for idle checking with the framework. This is intended for use with non-UI thread Loopers only.

Parameters
looper Looper

Throws
IllegalArgumentException if looper is the main looper.
NullPointerException if looper is null.

unregister

boolean unregister (IdlingResource... idlingResources)

Unregisters one or more IdlingResources.

Parameters
idlingResources IdlingResource

Returns
boolean true if at least one resource was successfully removed from the registry

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)