Package com.intellij.openapi.application

Interface AppUIExecutor

All Superinterfaces:

BaseExpirableExecutor<AppUIExecutor>

public interface AppUIExecutor
extends BaseExpirableExecutor<AppUIExecutor>

An executor that invokes given runnables under Write Intent lock on Swing Event Dispatch thread or Write Thread when all constraints of a given set are satisfied at the same time. The executor is created by calling onUiThread(com.intellij.openapi.application.ModalityState) (for EDT) or onWriteThread(com.intellij.openapi.application.ModalityState) (for WT), the constraints are specified by chained calls. For example, to invoke some action when all documents are committed and indices are available, one can use AppUIExecutor.onWriteThread().withDocumentsCommitted(project).inSmartMode(project).

Method Summary

Modifier and Type	Method and Description
AppUIExecutor	inSmartMode(Project project)
AppUIExecutor	inTransaction(Disposable parentDisposable) Deprecated. replace with later() or just remove it if you're in a write-safe context
AppUIExecutor	later()
static AppUIExecutor	onUiThread() Creates a EDT-based executor working with the default modality state.
static AppUIExecutor	onUiThread(ModalityState modality) Creates a EDT-based executor working with the given modality state.
static AppUIExecutor	onWriteThread() Creates a Write-thread-based executor working with the default modality state.
static AppUIExecutor	onWriteThread(ModalityState modality) Creates a Write-thread-based executor working with the given modality state.
AppUIExecutor	withDocumentsCommitted(Project project)

Methods inherited from interface com.intellij.openapi.application.BaseExpirableExecutor

execute, expireWith, submit, submit

Method Detail

onUiThread

static AppUIExecutor onUiThread(ModalityState modality)

Creates a EDT-based executor working with the given modality state.

See Also:

ModalityState

onWriteThread

static AppUIExecutor onWriteThread(ModalityState modality)

Creates a Write-thread-based executor working with the given modality state.

See Also:

ModalityState

onUiThread

static AppUIExecutor onUiThread()

Creates a EDT-based executor working with the default modality state.

See Also:

ModalityState.defaultModalityState()

onWriteThread

static AppUIExecutor onWriteThread()

Creates a Write-thread-based executor working with the default modality state.

See Also:

ModalityState.defaultModalityState()

later

AppUIExecutor later()

Returns:

an executor that should always invoke the given runnable later. Otherwise, if BaseExpirableExecutor.execute(java.lang.Runnable) is called on dispatch thread already, and all others constraints are met, the runnable would be executed immediately.

withDocumentsCommitted

AppUIExecutor withDocumentsCommitted(Project project)

Returns:

an executor that invokes runnables only when all documents are committed. Automatically expires when the project is disposed.

See Also:

PsiDocumentManager.hasUncommitedDocuments()

inSmartMode

AppUIExecutor inSmartMode(Project project)

Returns:

an executor that invokes runnables only when indices have been built and are available to use. Automatically expires when the project is disposed.

See Also:

DumbService.isDumb(Project)

inTransaction

@Deprecated
AppUIExecutor inTransaction(Disposable parentDisposable)

Deprecated. replace with later() or just remove it if you're in a write-safe context

See Also:

TransactionGuard