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

IdlingThreadPoolExecutor

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 class IdlingThreadPoolExecutor
extends ThreadPoolExecutor implements IdlingResource

java.lang.Object
↳	java.util.concurrent.AbstractExecutorService
	↳	java.util.concurrent.ThreadPoolExecutor
		↳	android.support.test.espresso.idling.concurrent.IdlingThreadPoolExecutor

---

A ThreadPoolExecutor that can be registered as an IdlingResource with Espresso.

Overrides parent methods to monitor threads starting, and finishing execution. Uses CountingIdlingResource to track number of active tasks.

This API is currently in beta.

Summary

Public constructors
IdlingThreadPoolExecutor(String resourceName, int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory) Creates a new IdlingThreadPoolExecutor with the given initial parameters and default rejected execution handler.

Public methods
void	execute(Runnable command)
String	getName() Returns the name of the resources (used for logging and idempotency of registration).
boolean	isIdleNow() Returns true if resource is currently idle.
void	registerIdleTransitionCallback(IdlingResource.ResourceCallback callback) Registers the given IdlingResource.ResourceCallback with the resource.

Protected methods
void	afterExecute(Runnable r, Throwable t)
void	terminated()

Inherited methods
From class java.util.concurrent.ThreadPoolExecutor void afterExecute(Runnable arg0, Throwable arg1) void allowCoreThreadTimeOut(boolean arg0) boolean allowsCoreThreadTimeOut() boolean awaitTermination(long arg0, TimeUnit arg1) void beforeExecute(Thread arg0, Runnable arg1) void execute(Runnable arg0) void finalize() int getActiveCount() long getCompletedTaskCount() int getCorePoolSize() long getKeepAliveTime(TimeUnit arg0) int getLargestPoolSize() int getMaximumPoolSize() int getPoolSize() BlockingQueue<Runnable> getQueue() RejectedExecutionHandler getRejectedExecutionHandler() long getTaskCount() ThreadFactory getThreadFactory() boolean isShutdown() boolean isTerminated() boolean isTerminating() int prestartAllCoreThreads() boolean prestartCoreThread() void purge() boolean remove(Runnable arg0) void setCorePoolSize(int arg0) void setKeepAliveTime(long arg0, TimeUnit arg1) void setMaximumPoolSize(int arg0) void setRejectedExecutionHandler(RejectedExecutionHandler arg0) void setThreadFactory(ThreadFactory arg0) void shutdown() List<Runnable> shutdownNow() void terminated() String toString()
From class java.util.concurrent.AbstractExecutorService <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> arg0) <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> arg0, long arg1, TimeUnit arg2) <T> T invokeAny(Collection<? extends Callable<T>> arg0) <T> T invokeAny(Collection<? extends Callable<T>> arg0, long arg1, TimeUnit arg2) <T> RunnableFuture<T> newTaskFor(Runnable arg0, T arg1) <T> RunnableFuture<T> newTaskFor(Callable<T> arg0) <T> Future<T> submit(Callable<T> arg0) <T> Future<T> submit(Runnable arg0, T arg1) Future<?> submit(Runnable arg0)
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 java.util.concurrent.ExecutorService abstract boolean awaitTermination(long arg0, TimeUnit arg1) abstract <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> arg0) abstract <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> arg0, long arg1, TimeUnit arg2) abstract <T> T invokeAny(Collection<? extends Callable<T>> arg0) abstract <T> T invokeAny(Collection<? extends Callable<T>> arg0, long arg1, TimeUnit arg2) abstract boolean isShutdown() abstract boolean isTerminated() abstract void shutdown() abstract List<Runnable> shutdownNow() abstract <T> Future<T> submit(Callable<T> arg0) abstract <T> Future<T> submit(Runnable arg0, T arg1) abstract Future<?> submit(Runnable arg0)
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.
From interface java.util.concurrent.Executor abstract void execute(Runnable arg0)

Public constructors

IdlingThreadPoolExecutor

IdlingThreadPoolExecutor (String resourceName, 
                int corePoolSize, 
                int maximumPoolSize, 
                long keepAliveTime, 
                TimeUnit unit, 
                BlockingQueue<Runnable> workQueue, 
                ThreadFactory threadFactory)

Creates a new IdlingThreadPoolExecutor with the given initial parameters and default rejected execution handler.

Parameters
resourceName	String: the name of the executor (used for logging and idempotency of registration).
corePoolSize	int: the number of threads to keep in the pool, even if they are idle, unless allowCoreThreadTimeOut is set.
maximumPoolSize	int: the maximum number of threads to allow in the pool.
keepAliveTime	long: when the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.
unit	TimeUnit: the time unit for the keepAliveTime argument.
workQueue	BlockingQueue: the queue to use for holding tasks before they are executed. This queue will hold only the Runnable tasks submitted by the execute method.
threadFactory	ThreadFactory: the factory to use when the executor creates a new thread.

Public methods

execute

void execute (Runnable command)

Parameters
command	Runnable

getName

String getName ()

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

Returns
String

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 callback)

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
callback	IdlingResource.ResourceCallback

Protected methods

afterExecute

void afterExecute (Runnable r, 
                Throwable t)

Parameters
r	Runnable
t	Throwable

terminated

void terminated ()

• Classes

  • IdlingScheduledThreadPoolExecutor
  • IdlingThreadPoolExecutor