Package com.intellij.util.concurrency

Class Invoker

java.lang.Object

com.intellij.util.concurrency.Invoker

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

Invoker.Background, Invoker.BackgroundThread, Invoker.EDT

public abstract class Invoker
extends java.lang.Object
implements Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Invoker.Background
static class	Invoker.BackgroundThread Deprecated. use Background(Disposable) instead
static class	Invoker.EDT This class is the Invoker in the Event Dispatch Thread, which is the only one valid thread for this invoker.

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
<T> CancellablePromise<T>	compute(java.util.function.Supplier<? extends T> task) Computes the specified task immediately if the current thread is valid, or asynchronously after all pending tasks have been processed.
<T> CancellablePromise<T>	computeLater(java.util.function.Supplier<? extends T> task) Computes the specified task asynchronously on the valid thread.
<T> CancellablePromise<T>	computeLater(java.util.function.Supplier<? extends T> task, int delay) Computes the specified task on the valid thread after the specified delay.
void	dispose() Usually not invoked directly, see class javadoc.
static Invoker	forBackgroundPoolWithReadAction(Disposable parent)
static Invoker	forBackgroundThreadWithoutReadAction(Disposable parent)
static Invoker	forBackgroundThreadWithReadAction(Disposable parent)
static Invoker	forEventDispatchThread(Disposable parent)
int	getTaskCount() Returns a workload of the task queue.
CancellablePromise<?>	invoke(java.lang.Runnable task) Invokes the specified task immediately if the current thread is valid, or asynchronously after all pending tasks have been processed.
CancellablePromise<?>	invokeLater(java.lang.Runnable task) Invokes the specified task asynchronously on the valid thread.
CancellablePromise<?>	invokeLater(java.lang.Runnable task, int delay) Invokes the specified task on the valid thread after the specified delay.
boolean	isValidThread() Returns true if the current thread allows to process a task.
CancellablePromise<?>	runOrInvokeLater(java.lang.Runnable task) Deprecated. use invoke(Runnable) or compute(Supplier) instead
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isValidThread

public boolean isValidThread()

Returns true if the current thread allows to process a task.

Returns:

true if the current thread is valid, or false otherwise

compute

public final <T> CancellablePromise<T> compute(java.util.function.Supplier<? extends T> task)

Computes the specified task immediately if the current thread is valid, or asynchronously after all pending tasks have been processed.

Parameters:

task - a task to execute on the valid thread

Returns:

an object to control task processing

computeLater

public final <T> CancellablePromise<T> computeLater(java.util.function.Supplier<? extends T> task)

Computes the specified task asynchronously on the valid thread. Even if this method is called from the valid thread the specified task will still be deferred until all pending events have been processed.

Parameters:

task - a task to execute asynchronously on the valid thread

Returns:

an object to control task processing

computeLater

public final <T> CancellablePromise<T> computeLater(java.util.function.Supplier<? extends T> task,
                                                    int delay)

Computes the specified task on the valid thread after the specified delay.

Parameters:

task - a task to execute asynchronously on the valid thread

delay - milliseconds for the initial delay

Returns:

an object to control task processing

invoke

public final CancellablePromise<?> invoke(java.lang.Runnable task)

Invokes the specified task immediately if the current thread is valid, or asynchronously after all pending tasks have been processed.

Parameters:

task - a task to execute on the valid thread

Returns:

an object to control task processing

invokeLater

public final CancellablePromise<?> invokeLater(java.lang.Runnable task)

Invokes the specified task asynchronously on the valid thread. Even if this method is called from the valid thread the specified task will still be deferred until all pending events have been processed.

Parameters:

task - a task to execute asynchronously on the valid thread

Returns:

an object to control task processing

invokeLater

public final CancellablePromise<?> invokeLater(java.lang.Runnable task,
                                               int delay)

Invokes the specified task on the valid thread after the specified delay.

Parameters:

task - a task to execute asynchronously on the valid thread

delay - milliseconds for the initial delay

Returns:

an object to control task processing

runOrInvokeLater

@Deprecated
public final CancellablePromise<?> runOrInvokeLater(java.lang.Runnable task)

Deprecated. use invoke(Runnable) or compute(Supplier) instead

Invokes the specified task immediately if the current thread is valid, or asynchronously after all pending tasks have been processed.

Parameters:

task - a task to execute on the valid thread

Returns:

an object to control task processing

getTaskCount

public final int getTaskCount()

Returns a workload of the task queue.

Returns:

amount of tasks, which are executing or waiting for execution

forEventDispatchThread

public static Invoker forEventDispatchThread(Disposable parent)

forBackgroundPoolWithReadAction

public static Invoker forBackgroundPoolWithReadAction(Disposable parent)

forBackgroundThreadWithReadAction

public static Invoker forBackgroundThreadWithReadAction(Disposable parent)

forBackgroundThreadWithoutReadAction

public static Invoker forBackgroundThreadWithoutReadAction(Disposable parent)