# UriIdlingResource

Artifact: [androidx.test.espresso.idling:idling-net](https://developer.android.com/jetpack/androidx/releases/test-espresso-idling) [View Source](https://cs.android.com/search?q=file:androidx/test/espresso/idling/net/UriIdlingResource.java+class:androidx.test.espresso.idling.net.UriIdlingResource)

*** ** * ** ***


```
public class UriIdlingResource implements IdlingResource
```

<br />

*** ** * ** ***

An implementation of `https://developer.android.com/reference/androidx/test/espresso/IdlingResource` useful for monitoring idleness of network traffic.

This is similar to androidx.test.espresso.contrib.CountingIdlingResource, with the additional idleness constraint that the counter must be 0 for a set period of time before the resource becomes idle.

A network timeout is required to be reasonably sure that the webview has finished loading. Imagine the case where each response that comes back causes another request to be made until loading is complete. The counter will go from 0-\>1-\>0-\>1-\>0-\>1..., but we don't want to report the webview as idle each time this happens.

## Summary

| ### Nested types |
|---|
| `public interface https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource.HandlerIntf` Wraps a Handler object. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#UriIdlingResource(java.lang.String,long)(https://developer.android.com/reference/java/lang/String.html resourceName, long timeoutMs)` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#beginLoad(java.lang.String)(https://developer.android.com/reference/java/lang/String.html uri)` Called when a request is made. |
| `void` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#endLoad(java.lang.String)(https://developer.android.com/reference/java/lang/String.html uri)` Called when a request is completed (ie the response is returned). |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#getName()()` Returns the name of the resources (used for logging and idempotency of registration). |
| `void` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#ignoreUri(java.util.regex.Pattern)(https://developer.android.com/reference/java/util/regex/Pattern.html pattern)` Add a regex pattern to the ignore list. |
| `boolean` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#isIdleNow()()` Returns `true` if resource is currently idle. |
| `void` | `https://developer.android.com/reference/androidx/test/espresso/idling/net/UriIdlingResource#registerIdleTransitionCallback(androidx.test.espresso.IdlingResource.ResourceCallback)( https://developer.android.com/reference/androidx/test/espresso/IdlingResource.ResourceCallback resourceCallback )` Registers the given `https://developer.android.com/reference/androidx/test/espresso/IdlingResource.ResourceCallback` with the resource. |

## Public constructors

### UriIdlingResource

```
public UriIdlingResource(String resourceName, long timeoutMs)
```

## Public methods

### beginLoad

```
public void beginLoad(String uri)
```

Called when a request is made.

If the URI is not blacklisted the idle counter is incremented.

### endLoad

```
public void endLoad(String uri)
```

Called when a request is completed (ie the response is returned).

If the URI is not blacklisted the idle counter is decremented. Once the idle counter reaches 0, the idle update thread will set the resource as idle after the appropriate timeout.

### getName

```
public String getName()
```

Returns the name of the resources (used for logging and idempotency of registration).

### ignoreUri

```
public void ignoreUri(Pattern pattern)
```

Add a regex pattern to the ignore list.

All request URIs are checked against all patterns, and matches are ignored for the purposes of detecting when the webview is idle.

Ignored patterns can only be added when the webview is idle.

### isIdleNow

```
public boolean isIdleNow()
```

Returns `true` if resource is currently idle. Espresso will **always** call this method from the main thread, therefore it should be non-blocking and return immediately.

### registerIdleTransitionCallback

```
public void registerIdleTransitionCallback(
    IdlingResource.ResourceCallback resourceCallback
)
```

Registers the given `https://developer.android.com/reference/androidx/test/espresso/IdlingResource.ResourceCallback` with the resource. Espresso will call this method:

- with its implementation of `https://developer.android.com/reference/androidx/test/espresso/IdlingResource.ResourceCallback` so it can be notified asynchronously that your resource is idle
- from the main thread, but you are free to execute the callback's onTransitionToIdle from any thread
- once (when it is initially given a reference to your IdlingResource)

You only need to call this upon transition from busy to idle - if the resource is already idle when the method is called invoking the call back is optional and has no significant impact.