public final class CountingIdlingResource
extends Object
implements IdlingResource
java.lang.Object | |
↳ | android.support.test.espresso.contrib.CountingIdlingResource |
This class is deprecated.
Use CountingIdlingResource
instead. This class has been moved to a different module to avoid a dependency on espresso-contrib in your production code. This class will be removed in a future release.
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);
}
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 |
void |
registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback) Registers the given |
Inherited methods |
|
---|---|
![]() java.lang.Object
|
|
![]() android.support.test.espresso.IdlingResource
|
CountingIdlingResource (String resourceName)
Creates a CountingIdlingResource without debug tracing.
Parameters | |
---|---|
resourceName |
String : the resource name this resource should report to Espresso. |
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. |
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. |
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).
Returns | |
---|---|
String |
void increment ()
Increments the count of in-flight transactions to the resource being monitored. This method can be called from any thread.
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 |
void registerIdleTransitionCallback (IdlingResource.ResourceCallback resourceCallback)
Registers the given IdlingResource.ResourceCallback
with the resource. Espresso will call this method:
IdlingResource.ResourceCallback
so it can be notified asynchronously that your resource is idle Parameters | |
---|---|
resourceCallback |
IdlingResource.ResourceCallback
|