Summary: Ctors | Methods | Inherited Methods | [Expand All]

CountingIdlingResource

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class CountingIdlingResource
extends Object implements IdlingResource

java.lang.Object
↳	android.support.test.espresso.idling.CountingIdlingResource

---

An implementation of IdlingResource that determines idleness by maintaining an internal counter. When the counter is 0 - it is considered to be idle, when it is non-zero it is not idle. This is very similar to the way a Semaphore behaves.

The counter may be incremented or decremented from any thread. If it reaches an illogical state (like counter less than zero) it will throw an IllegalStateException.

This class can then be used to wrap up operations that while in progress should block tests from accessing the UI.

public interface FooServer {
   public Foo newFoo();
   public void updateFoo(Foo foo);
 }

 public DecoratedFooServer implements FooServer {
   private final FooServer realFooServer;
   private final CountingIdlingResource fooServerIdlingResource;

   public DecoratedFooServer(FooServer realFooServer,
       CountingIdlingResource fooServerIdlingResource) {
     this.realFooServer = checkNotNull(realFooServer);
     this.fooServerIdlingResource = checkNotNull(fooServerIdlingResource);
   }

   public Foo newFoo() {
     fooServerIdlingResource.increment();
     try {
       return realFooServer.newFoo();
     } finally {
       fooServerIdlingResource.decrement();
     }
   }

   public void updateFoo(Foo foo) {
     fooServerIdlingResource.increment();
     try {
       realFooServer.updateFoo(foo);
     } finally {
       fooServerIdlingResource.decrement();
     }
   }
 }
 

Then in your test setup:

public void setUp() throws Exception {
   super.setUp();
   FooServer realServer = FooApplication.getFooServer();
   CountingIdlingResource countingResource = new CountingIdlingResource("FooServerCalls");
   FooApplication.setFooServer(new DecoratedFooServer(realServer, countingResource));
   Espresso.registerIdlingResource(countingResource);
 }
 

Summary

Public constructors
CountingIdlingResource(String resourceName) Creates a CountingIdlingResource without debug tracing.
CountingIdlingResource(String resourceName, boolean debugCounting) Creates a CountingIdlingResource.

Public methods
void	decrement() Decrements the count of in-flight transactions to the resource being monitored.
void	dumpStateToLogs() Prints the current state of this resource to the logcat at info level.
String	getName() Returns the name of the resources (used for logging and idempotency of registration).
void	increment() Increments the count of in-flight transactions to the resource being monitored.
boolean	isIdleNow() Returns true if resource is currently idle.
void	registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback) Registers the given IdlingResource.ResourceCallback with the resource.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.support.test.espresso.IdlingResource abstract String getName() Returns the name of the resources (used for logging and idempotency of registration). abstract boolean isIdleNow() Returns true if resource is currently idle. abstract void registerIdleTransitionCallback(IdlingResource.ResourceCallback callback) Registers the given IdlingResource.ResourceCallback with the resource.

Public constructors

CountingIdlingResource

CountingIdlingResource (String resourceName)

Creates a CountingIdlingResource without debug tracing.

Parameters
resourceName	String: the resource name this resource should report to Espresso.

CountingIdlingResource

CountingIdlingResource (String resourceName, 
                boolean debugCounting)

Creates a CountingIdlingResource.

Parameters
resourceName	String: the resource name this resource should report to Espresso.
debugCounting	boolean: if true increment & decrement calls will print trace information to logs.

Public methods

decrement

void decrement ()

Decrements the count of in-flight transactions to the resource being monitored.

If this operation results in the counter falling below 0 - an exception is raised.

Throws
IllegalStateException	if the counter is below 0.

dumpStateToLogs

void dumpStateToLogs ()

Prints the current state of this resource to the logcat at info level.

getName

String getName ()

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

Returns
String

increment

void increment ()

Increments the count of in-flight transactions to the resource being monitored.

This method can be called from any thread.

isIdleNow

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.

Returns
boolean

registerIdleTransitionCallback

void registerIdleTransitionCallback (IdlingResource.ResourceCallback resourceCallback)

Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method:

• with its implementation of 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.

Parameters
resourceCallback	IdlingResource.ResourceCallback

• Classes

  • CountingIdlingResource