IdlingRegistry

Artifact: androidx.test.espresso:espresso-idling-resource

Kotlin |Java

public final class 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 fields
`static final IdlingRegistry`	`instance`

Public methods
`static IdlingRegistry`	`getInstance()` Returns a singleton instance of this `IdlingRegistry` that should be globally used for registering and unregistering `IdlingResource`s
`Collection<Looper>`	`getLoopers()` Returns a set of all currently registered `Looper`s.
`Collection<IdlingResource>`	`getResources()` Returns a set of all currently registered `IdlingResource`s.
`boolean`	`register(IdlingResource[] idlingResources)` Registers one or more `IdlingResource`s.
`void`	`registerLooperAsIdlingResource(Looper looper)` Registers a `Looper` for idle checking with the framework.
`boolean`	`unregister(IdlingResource[] idlingResources)` Unregisters one or more `IdlingResource`s.
`boolean`	`unregisterLooperAsIdlingResource(Looper looper)` Unregisters a `Looper`.

Public fields

instance

public static final IdlingRegistry instance

Public methods

getInstance

public static IdlingRegistry getInstance()

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

getLoopers

public Collection<Looper> getLoopers()

Returns a set of all currently registered Loopers.

getResources

public Collection<IdlingResource> getResources()

Returns a set of all currently registered IdlingResources.

register

public 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

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

registerLooperAsIdlingResource

public void registerLooperAsIdlingResource(Looper looper)

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

Throws
`java.lang.IllegalArgumentException`	if looper is the main looper.
`java.lang.NullPointerException`	if looper is null.

unregister

public boolean unregister(IdlingResource[] idlingResources)

Unregisters one or more IdlingResources.

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

unregisterLooperAsIdlingResource

public boolean unregisterLooperAsIdlingResource(Looper looper)

Unregisters a Looper.

Attempting to unregister a looper that is not registered is a no-op.

Returns
`boolean`	`true` if the looper was successfully removed from the registry