Package com.intellij.openapi.project

Class DumbServiceImpl

java.lang.Object

com.intellij.openapi.project.DumbService

com.intellij.openapi.project.DumbServiceImpl

All Implemented Interfaces:

Disposable, ModificationTracker

Direct Known Subclasses:

LightEditDumbService

public class DumbServiceImpl
extends DumbService
implements Disposable, ModificationTracker

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.project.DumbService

DumbService.DumbModeListener

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

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.openapi.project.DumbService

DUMB_MODE

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
DumbServiceImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	cancelAllTasksAndWait() Cancels all tasks and wait when their execution is finished.
void	cancelTask(DumbModeTask task) Cancels the given task.
void	completeJustSubmittedTasks() Runs the "just submitted" tasks under a modal dialog.
void	dispose() Usually not invoked directly, see class javadoc.
java.lang.Throwable	getDumbModeStartTrace()
static DumbServiceImpl	getInstance(Project project)
long	getModificationCount()
ModificationTracker	getModificationTracker() The tracker is advanced each time we enter/exit from dumb mode.
Project	getProject()
boolean	isAlternativeResolveEnabled()
boolean	isDumb() To avoid race conditions use it only in EDT thread or inside read-action.
boolean	isSuspendedDumbMode() Checks whether DumbService.isDumb() is true for the current project and if it's currently suspended by user or a DumbService.suspendIndexingAndRun(java.lang.String, java.lang.Runnable) call.
void	queueTask(DumbModeTask task) Queues a task to be executed in "dumb mode", where access to indexes is forbidden.
void	runWhenSmart(java.lang.Runnable runnable) Executes the runnable as soon as possible on AWT Event Dispatch when: project is initialized and there's no dumb mode in progress This may also happen immediately if these conditions are already met. Note that it's not guaranteed that the dumb mode won't start again during this runnable execution, it should manage that situation explicitly.
void	setAlternativeResolveEnabled(boolean enabled) Enables or disables alternative resolve strategies for the current thread.
void	setDumb(boolean dumb)
boolean	showDumbModeDialog(java.util.List<java.lang.String> actionNames) Show modal progress about indexing blocking those actions until it is cancelled or indexing stops.
void	showDumbModeNotification(java.lang.String message) Show a notification when given action is not available during dumb mode.
void	smartInvokeLater(java.lang.Runnable runnable) Invoke the runnable later on EventDispatchThread AND when IDE isn't in dumb mode.
void	smartInvokeLater(java.lang.Runnable runnable, ModalityState modalityState) Invoke the runnable later on EventDispatchThread with the given modality state AND when IDE isn't in dumb mode.
void	suspendIndexingAndRun(java.lang.String activityName, java.lang.Runnable activity) Runs a heavy activity and suspends indexing (if any) for this time.
void	unsafeRunWhenSmart(java.lang.Runnable runnable)
void	waitForSmartMode() Pause the current thread until dumb mode ends and then continue execution.
javax.swing.JComponent	wrapGently(javax.swing.JComponent dumbUnawareContent, Disposable parentDisposable) Replaces given component temporarily with "Not available until indices are built" label during dumb mode.
javax.swing.JComponent	wrapWithSpoiler(javax.swing.JComponent dumbAwareContent, java.lang.Runnable updateRunnable, Disposable parentDisposable) Adds a "Results might be incomplete while indexing." decorator to a given component during dumb mode.

Methods inherited from class com.intellij.openapi.project.DumbService

allowStartingDumbModeInside, computeWithAlternativeResolveEnabled, filterByDumbAwareness, filterByDumbAwareness, getDumbAwareExtensions, getDumbAwareExtensions, isDumb, isDumbAware, makeDumbAware, repeatUntilPassesInSmartMode, runReadActionInSmartMode, runReadActionInSmartMode, runWithAlternativeResolveEnabled, tryRunReadActionInSmartMode, withAlternativeResolveEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

DumbServiceImpl

public DumbServiceImpl(Project project)

Method Detail

getInstance

public static DumbServiceImpl getInstance(Project project)

cancelTask

public void cancelTask(DumbModeTask task)

Description copied from class: DumbService

Cancels the given task. If it's in the queue, it won't be executed. If it's already running, its ProgressIndicator is canceled, so the next ProgressManager.checkCanceled() call will throw ProcessCanceledException.

Specified by:

cancelTask in class DumbService

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getProject

public Project getProject()

Specified by:

getProject in class DumbService

isAlternativeResolveEnabled

public boolean isAlternativeResolveEnabled()

Specified by:

isAlternativeResolveEnabled in class DumbService

Returns:

whether alternative resolution is enabled for the current thread.

See Also:

DumbService.setAlternativeResolveEnabled(boolean)

suspendIndexingAndRun

public void suspendIndexingAndRun(java.lang.String activityName,
                                  java.lang.Runnable activity)

Description copied from class: DumbService

Runs a heavy activity and suspends indexing (if any) for this time. The user still can manually pause and resume the indexing. In that case, indexing won't be resumed automatically after the activity finishes.

Specified by:

suspendIndexingAndRun in class DumbService

Parameters:

activityName - the text (a noun phrase) to display as a reason for the indexing being paused

isSuspendedDumbMode

public boolean isSuspendedDumbMode()

Description copied from class: DumbService

Checks whether DumbService.isDumb() is true for the current project and if it's currently suspended by user or a DumbService.suspendIndexingAndRun(java.lang.String, java.lang.Runnable) call. This should be called inside read action. The momentary system state is returned: there are no guarantees that the result won't change in the next line of the calling code.

Specified by:

isSuspendedDumbMode in class DumbService

setAlternativeResolveEnabled

public void setAlternativeResolveEnabled(boolean enabled)

Description copied from class: DumbService

Enables or disables alternative resolve strategies for the current thread.

Normally reference resolution uses indexes, and hence is not available in dumb mode. In some cases, alternative ways of performing resolve are available, although much slower. It's impractical to always use these ways because it'll lead to overloaded CPU (especially given there's also indexing in progress). But for some explicit user actions (e.g., explicit Goto Declaration) turning on these slower methods is beneficial.

NOTE: even with alternative resolution enabled, methods like resolve(), findClass() etc may still throw IndexNotReadyException. So alternative resolve is not a panacea, it might help provide navigation in some cases but not in all.

A typical usage would involve try-finally, where the alternative resolution is first enabled, then an action is performed, and then alternative resolution is turned off in the finally block.

Specified by:

setAlternativeResolveEnabled in class DumbService

getModificationTracker

public ModificationTracker getModificationTracker()

Description copied from class: DumbService

The tracker is advanced each time we enter/exit from dumb mode.

Specified by:

getModificationTracker in class DumbService

isDumb

public boolean isDumb()

Description copied from class: DumbService

To avoid race conditions use it only in EDT thread or inside read-action. See documentation for this class DumbService

Specified by:

isDumb in class DumbService

Returns:

whether the IDE is in dumb mode, which means that right now indexes are updated in the background. The IDE offers only limited functionality at such times, e.g., plain text file editing and version control operations.

setDumb

public void setDumb(boolean dumb)

runWhenSmart

public void runWhenSmart(java.lang.Runnable runnable)

Description copied from class: DumbService

Executes the runnable as soon as possible on AWT Event Dispatch when:

• project is initialized
• and there's no dumb mode in progress

This may also happen immediately if these conditions are already met.

Note that it's not guaranteed that the dumb mode won't start again during this runnable execution, it should manage that situation explicitly.

Specified by:

runWhenSmart in class DumbService

unsafeRunWhenSmart

public void unsafeRunWhenSmart(java.lang.Runnable runnable)

Specified by:

unsafeRunWhenSmart in class DumbService

queueTask

public void queueTask(DumbModeTask task)

Description copied from class: DumbService

Queues a task to be executed in "dumb mode", where access to indexes is forbidden. Tasks are executed sequentially in background unless DumbService.completeJustSubmittedTasks() is called in the same dispatch thread activity.

Tasks can specify custom "equality" policy via their constructor. Calling this method has no effect if an "equal" task is already enqueued (but not yet running).

Specified by:

queueTask in class DumbService

showDumbModeNotification

public void showDumbModeNotification(java.lang.String message)

Description copied from class: DumbService

Show a notification when given action is not available during dumb mode.

Specified by:

showDumbModeNotification in class DumbService

showDumbModeDialog

public boolean showDumbModeDialog(java.util.List<java.lang.String> actionNames)

Description copied from class: DumbService

Show modal progress about indexing blocking those actions until it is cancelled or indexing stops.

Specified by:

showDumbModeDialog in class DumbService

Returns:

true if indexing stopped, and the dialog was not cancelled.

cancelAllTasksAndWait

public void cancelAllTasksAndWait()

Description copied from class: DumbService

Cancels all tasks and wait when their execution is finished. Should be called on write thread.

Specified by:

cancelAllTasksAndWait in class DumbService

waitForSmartMode

public void waitForSmartMode()

Description copied from class: DumbService

Pause the current thread until dumb mode ends and then continue execution. NOTE: there are no guarantees that a new dumb mode won't begin before the next statement. Hence: use with care. Consider using DumbService.runWhenSmart(Runnable) or DumbService.runReadActionInSmartMode(Runnable) instead

Specified by:

waitForSmartMode in class DumbService

wrapGently

public javax.swing.JComponent wrapGently(javax.swing.JComponent dumbUnawareContent,
                                         Disposable parentDisposable)

Description copied from class: DumbService

Replaces given component temporarily with "Not available until indices are built" label during dumb mode.

Specified by:

wrapGently in class DumbService

Returns:

Wrapped component.

wrapWithSpoiler

public javax.swing.JComponent wrapWithSpoiler(javax.swing.JComponent dumbAwareContent,
                                              java.lang.Runnable updateRunnable,
                                              Disposable parentDisposable)

Description copied from class: DumbService

Adds a "Results might be incomplete while indexing." decorator to a given component during dumb mode.

Specified by:

wrapWithSpoiler in class DumbService

Parameters:

dumbAwareContent - - a component to wrap

updateRunnable - - an action to execute when dumb mode state changed or user explicitly request reload panel

Returns:

Wrapped component.

smartInvokeLater

public void smartInvokeLater(java.lang.Runnable runnable)

Description copied from class: DumbService

Invoke the runnable later on EventDispatchThread AND when IDE isn't in dumb mode. The runnable won't be invoked if the project is disposed during dumb mode.

Specified by:

smartInvokeLater in class DumbService

smartInvokeLater

public void smartInvokeLater(java.lang.Runnable runnable,
                             ModalityState modalityState)

Description copied from class: DumbService

Invoke the runnable later on EventDispatchThread with the given modality state AND when IDE isn't in dumb mode. The runnable won't be invoked if the project is disposed during dumb mode.

Specified by:

smartInvokeLater in class DumbService

completeJustSubmittedTasks

public void completeJustSubmittedTasks()

Description copied from class: DumbService

Runs the "just submitted" tasks under a modal dialog. "Just submitted" means that tasks were queued for execution earlier within the same Swing event dispatch thread event processing, and there were no other tasks already running at that moment. Otherwise, this method does nothing.

This functionality can be useful in refactorings (invoked in "smart mode"), when after VFS or root changes (which could start "dumb mode") some reference resolve is required (which again requires "smart mode").

Should be invoked on dispatch thread. It's the caller's responsibility to invoke this method only when the model is in internally consistent state, so that background threads with read actions don't see half-baked PSI/VFS/etc.

Specified by:

completeJustSubmittedTasks in class DumbService

getModificationCount

public long getModificationCount()

Specified by:

getModificationCount in interface ModificationTracker

getDumbModeStartTrace

public java.lang.Throwable getDumbModeStartTrace()