Package com.intellij.openapi.project

Class IndexNotReadyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.intellij.openapi.project.IndexNotReadyException

All Implemented Interfaces:

ExceptionWithAttachments, java.io.Serializable

public class IndexNotReadyException
extends java.lang.RuntimeException
implements ExceptionWithAttachments

Thrown on accessing indices when they're not ready, in so-called dumb mode. Possible fixes:

• If AnAction.actionPerformed(com.intellij.openapi.actionSystem.AnActionEvent) is in stack trace, consider making the action not implement DumbAware.
• A DumbAware action, having got this exception, may just notify the user that the requested activity is not possible while indexing is in progress. It can be done via a dialog (see Messages) or a status bar balloon (see DumbService.showDumbModeNotification(String), ActionUtil.showDumbModeWarning(com.intellij.openapi.actionSystem.AnActionEvent...)).
• If index access is performed from some non-urgent invokeLater activity, consider replacing it with DumbService.smartInvokeLater(Runnable). Note that this 'later' can be very late, several minutes may pass. So if that code involves user interaction, DumbService.smartInvokeLater(Runnable) should probably not be used to avoid dialogs popping out of the blue.
• If it's a non-urgent background process (e.g. compilation, usage search), consider replacing topmost read-action with DumbService.runReadActionInSmartMode(Computable).
• If the exception comes from within Java's findClass call, and the IDE is currently performing a user-initiated action or a task when skipping findClass would lead to very negative consequences (e.g. not stopping at a breakpoint), then it might be possible to avoid index query by using alternative resolve (and findClass) strategy, which is significantly slower and might return null. To do this, use DumbService.runWithAlternativeResolveEnabled(ThrowableRunnable) or similar.
• If you're performing a long modal operation which leads to a root change in the middle (or otherwise causes indexing), but you need indices after that, you can call DumbService.completeJustSubmittedTasks() before performing those index queries.
• It's preferable to avoid the exception entirely by adding DumbService.isDumb() checks where necessary.

See Also:

DumbService, DumbAware, Serialized Form

Method Summary

Modifier and Type	Method and Description
static IndexNotReadyException	create()
static IndexNotReadyException	create(java.lang.Throwable startTrace)
Attachment []	getAttachments()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getAttachments

public Attachment [] getAttachments()

Specified by:

getAttachments in interface ExceptionWithAttachments

create

public static IndexNotReadyException create()

create

public static IndexNotReadyException create(java.lang.Throwable startTrace)