# IdlingPolicy

Summary: [Methods](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#inhmethods) \| [\[Expand All\]](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#)  

# IdlingPolicy

| This package is part of the Android [support library](https://developer.android.com/topic/libraries/support-library) which is no longer maintained. The support library has been superseded by [AndroidX](https://developer.android.com/jetpack/androidx) which is part of [Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider [migrating](https://developer.android.com/jetpack/androidx/migrate) existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library [class
| mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).


`
public

final

class
IdlingPolicy
`


`

extends `[Object](https://developer.android.com/reference/java/lang/Object.html)`


`

`


`

|---|--------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||
| ↳ | android.support.test.espresso.IdlingPolicy |

<br />

*** ** * ** ***

Allows users to control idling idleTimeouts in Espresso.

## Summary

|                                                                                                                                                                                                                                                                               ### Public methods                                                                                                                                                                                                                                                                               ||
|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` long`                                                                                   | ` `[getIdleTimeout](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#getIdleTimeout())`() ` The amount of time the policy allows a resource to be non-idle.                                                                                                                                                                                                                                                                                       |
| ` `[TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html) | ` `[getIdleTimeoutUnit](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#getIdleTimeoutUnit())`() ` The unit for [getIdleTimeout()](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#getIdleTimeout()).                                                                                                                                                                                                         |
| ` void`                                                                                   | ` `[handleTimeout](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#handleTimeout(java.util.List<java.lang.String>, java.lang.String))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`> busyResources, `[String](https://developer.android.com/reference/java/lang/String.html)` message) ` Invoked when the idle idleTimeout has been exceeded. |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#)From class ` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object.html)` ` |-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object.html)          | ` clone() `                                                                                | | ` boolean`                                                                          | ` equals(`[Object](https://developer.android.com/reference/java/lang/Object.html)` arg0) ` | | ` void`                                                                             | ` finalize() `                                                                             | | ` final `[Class](https://developer.android.com/reference/java/lang/Class.html)`<?>` | ` getClass() `                                                                             | | ` int`                                                                              | ` hashCode() `                                                                             | | ` final void`                                                                       | ` notify() `                                                                               | | ` final void`                                                                       | ` notifyAll() `                                                                            | | ` `[String](https://developer.android.com/reference/java/lang/String.html)          | ` toString() `                                                                             | | ` final void`                                                                       | ` wait(long arg0, int arg1) `                                                              | | ` final void`                                                                       | ` wait(long arg0) `                                                                        | | ` final void`                                                                       | ` wait() `                                                                                 | ||

## Public methods

### getIdleTimeout

```
long getIdleTimeout ()
```

The amount of time the policy allows a resource to be non-idle.

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getIdleTimeoutUnit

```
TimeUnit getIdleTimeoutUnit ()
```

The unit for [getIdleTimeout()](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy#getIdleTimeout()).

<br />

|                                            Returns                                             ||
|----------------------------------------------------------------------------------------|--------|
| [TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html) | <br /> |

### handleTimeout

```
void handleTimeout (List<String> busyResources, 
                String message)
```

Invoked when the idle idleTimeout has been exceeded.

<br />

|                                     Parameters                                      ||
|-----------------|--------------------------------------------------------------------|
| `busyResources` | `List`: the resources that are not idle. <br />                    |
| `message`       | `String`: an additional message to include in an exception. <br /> |

-

  ## Interfaces

  - [EspressoException](https://developer.android.com/reference/android/support/test/espresso/EspressoException)
  - [FailureHandler](https://developer.android.com/reference/android/support/test/espresso/FailureHandler)
  - [IdlingResource](https://developer.android.com/reference/android/support/test/espresso/IdlingResource)
  - [IdlingResource.ResourceCallback](https://developer.android.com/reference/android/support/test/espresso/IdlingResource.ResourceCallback)
  - [UiController](https://developer.android.com/reference/android/support/test/espresso/UiController)
  - [ViewAction](https://developer.android.com/reference/android/support/test/espresso/ViewAction)
  - [ViewAssertion](https://developer.android.com/reference/android/support/test/espresso/ViewAssertion)
  - [ViewFinder](https://developer.android.com/reference/android/support/test/espresso/ViewFinder)
  - [ViewInteractionComponent](https://developer.android.com/reference/android/support/test/espresso/ViewInteractionComponent)
-

  ## Classes

  - [AmbiguousViewMatcherException.Builder](https://developer.android.com/reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder)
  - [DataInteraction](https://developer.android.com/reference/android/support/test/espresso/DataInteraction)
  - [DataInteraction.DisplayDataMatcher](https://developer.android.com/reference/android/support/test/espresso/DataInteraction.DisplayDataMatcher)
  - [Espresso](https://developer.android.com/reference/android/support/test/espresso/Espresso)
  - [IdlingPolicies](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicies)
  - [IdlingPolicy](https://developer.android.com/reference/android/support/test/espresso/IdlingPolicy)
  - [IdlingRegistry](https://developer.android.com/reference/android/support/test/espresso/IdlingRegistry)
  - [NoMatchingViewException.Builder](https://developer.android.com/reference/android/support/test/espresso/NoMatchingViewException.Builder)
  - [PerformException.Builder](https://developer.android.com/reference/android/support/test/espresso/PerformException.Builder)
  - [Root](https://developer.android.com/reference/android/support/test/espresso/Root)
  - [Root.Builder](https://developer.android.com/reference/android/support/test/espresso/Root.Builder)
  - [ViewInteraction](https://developer.android.com/reference/android/support/test/espresso/ViewInteraction)
-

  ## Exceptions

  - [AmbiguousViewMatcherException](https://developer.android.com/reference/android/support/test/espresso/AmbiguousViewMatcherException)
  - [AppNotIdleException](https://developer.android.com/reference/android/support/test/espresso/AppNotIdleException)
  - [IdlingResourceTimeoutException](https://developer.android.com/reference/android/support/test/espresso/IdlingResourceTimeoutException)
  - [InjectEventSecurityException](https://developer.android.com/reference/android/support/test/espresso/InjectEventSecurityException)
  - [NoActivityResumedException](https://developer.android.com/reference/android/support/test/espresso/NoActivityResumedException)
  - [NoMatchingRootException](https://developer.android.com/reference/android/support/test/espresso/NoMatchingRootException)
  - [NoMatchingViewException](https://developer.android.com/reference/android/support/test/espresso/NoMatchingViewException)
  - [PerformException](https://developer.android.com/reference/android/support/test/espresso/PerformException)