Package com.intellij.util.indexing

Class FileBasedIndexImpl

java.lang.Object

com.intellij.util.indexing.FileBasedIndex

com.intellij.util.indexing.FileBasedIndexEx

com.intellij.util.indexing.FileBasedIndexImpl

public final class FileBasedIndexImpl
extends FileBasedIndexEx

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.util.indexing.FileBasedIndex

FileBasedIndex.FileTypeSpecificInputFilter, FileBasedIndex.InputFilter, FileBasedIndex.ValueProcessor<V>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DO_TRACE_STUB_INDEX_UPDATE

Fields inherited from class com.intellij.util.indexing.FileBasedIndex

ourEnableTracingOfKeyHashToVirtualFileMapping, ourSnapshotMappingsEnabled

Constructor Summary

Constructors

Constructor and Description
FileBasedIndexImpl()

Method Summary

Modifier and Type	Method and Description
void	cleanupForNextTest()
static void	cleanupProcessedFlag()
static <T,E extends java.lang.Throwable> T	disableUpToDateCheckIn(ThrowableComputable<T,E> runnable)
void	dropNontrivialIndexedStates(int inputId)
<K> boolean	ensureUpToDate(ID<K,?> indexId, Project project, GlobalSearchScope filter, VirtualFile restrictedFile)
VirtualFile	findFileById(Project project, int id)
void	flushIndexes()
java.util.function.IntPredicate	getAccessibleFileIdFilter(Project project)
static java.lang.Throwable	getCauseToRebuildIndex(java.lang.RuntimeException e)
ChangedFilesCollector	getChangedFilesCollector()
DumbModeAccessType	getCurrentDumbModeAccessType()
VirtualFile	getFileBeingCurrentlyIndexed()
<K,V> UpdatableIndex<K,V,FileContent>	getIndex(ID<K,V> indexId)
void	ignoreDumbMode(java.lang.Runnable command, Project project, DumbModeAccessType dumbModeAccessType) Executes command and allow its to have an index access in dumb mode.
void	indexFiles(Project project, java.util.Collection<VirtualFile> files, ProgressIndicator indicator)
void	invalidateCaches()
boolean	isFileUpToDate(VirtualFile file)
boolean	isIndexingCandidate(VirtualFile file, ID<?,?> indexId)
static boolean	isProjectOrWorkspaceFile(VirtualFile file, FileType fileType)
static boolean	isPsiDependentIndex(IndexExtension<?,?,?> extension)
ProjectIndexableFilesFilter	projectIndexableFiles(Project project)
void	registerIndexableSet(IndexableFileSet set, Project project)
void	removeIndexableSet(IndexableFileSet set)
void	requestRebuild(ID<?,?> indexId, java.lang.Throwable throwable)
void	requestReindex(VirtualFile file)
void	runCleanupAction(java.lang.Runnable cleanupAction)

Methods inherited from class com.intellij.util.indexing.FileBasedIndexEx

ensureUpToDate, getAllKeys, getContainingFiles, getFileData, getFilesWithKey, getIndexModificationStamp, getOrderedIndexableFilesProviders, getValues, iterateIndexableFiles, processAllKeys, processAllKeys, processFilesContainingAllKeys, processValues, processValues, scheduleRebuild

Methods inherited from class com.intellij.util.indexing.FileBasedIndex

getFileId, getInstance, isIndexAccessDuringDumbModeEnabled, iterateRecursively, requestRebuild

Methods inherited from class java.lang.Object

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

Field Detail

DO_TRACE_STUB_INDEX_UPDATE

public static final boolean DO_TRACE_STUB_INDEX_UPDATE

Constructor Detail

FileBasedIndexImpl

public FileBasedIndexImpl()

Method Detail

isProjectOrWorkspaceFile

public static boolean isProjectOrWorkspaceFile(VirtualFile file,
                                               FileType fileType)

requestReindex

public void requestReindex(VirtualFile file)

Specified by:

requestReindex in class FileBasedIndex

disableUpToDateCheckIn

public static <T,E extends java.lang.Throwable> T disableUpToDateCheckIn(ThrowableComputable<T,E> runnable)
                                                                  throws E extends java.lang.Throwable

Throws:

E extends java.lang.Throwable

ignoreDumbMode

public void ignoreDumbMode(java.lang.Runnable command,
                           Project project,
                           DumbModeAccessType dumbModeAccessType)

Description copied from class: FileBasedIndex

Executes command and allow its to have an index access in dumb mode. Inside the command it's safe to call index related stuff and IndexNotReadyException are not expected to be happen here.

In smart mode, the behavior is similar to direct command execution

Overrides:

ignoreDumbMode in class FileBasedIndex

Parameters:

command - - a command to execute

project - - project where dumb mode will be ignored

dumbModeAccessType - - defines in which manner command should be executed. Does a client expect only reliable data or any data from index is fine (even outdated and not yet updated)?

ensureUpToDate

public <K> boolean ensureUpToDate(ID<K,?> indexId,
                                  Project project,
                                  GlobalSearchScope filter,
                                  VirtualFile restrictedFile)

Specified by:

ensureUpToDate in class FileBasedIndexEx

Returns:

true if index can be processed after it or false if no need to process it because, for example, scope is empty or index is going to rebuild.

cleanupForNextTest

public void cleanupForNextTest()

getChangedFilesCollector

public ChangedFilesCollector getChangedFilesCollector()

projectIndexableFiles

public ProjectIndexableFilesFilter projectIndexableFiles(Project project)

Specified by:

projectIndexableFiles in class FileBasedIndexEx

getCauseToRebuildIndex

public static java.lang.Throwable getCauseToRebuildIndex(java.lang.RuntimeException e)

runCleanupAction

public void runCleanupAction(java.lang.Runnable cleanupAction)

requestRebuild

public void requestRebuild(ID<?,?> indexId,
                           java.lang.Throwable throwable)

Specified by:

requestRebuild in class FileBasedIndex

getIndex

public <K,V> UpdatableIndex<K,V,FileContent> getIndex(ID<K,V> indexId)

isFileUpToDate

public boolean isFileUpToDate(VirtualFile file)

indexFiles

public void indexFiles(Project project,
                       java.util.Collection<VirtualFile> files,
                       ProgressIndicator indicator)

isIndexingCandidate

public boolean isIndexingCandidate(VirtualFile file,
                                   ID<?,?> indexId)

getFileBeingCurrentlyIndexed

public VirtualFile getFileBeingCurrentlyIndexed()

Specified by:

getFileBeingCurrentlyIndexed in class FileBasedIndex

Returns:

the file which the current thread is indexing right now, or null if current thread isn't indexing.

getCurrentDumbModeAccessType

public DumbModeAccessType getCurrentDumbModeAccessType()

Overrides:

getCurrentDumbModeAccessType in class FileBasedIndex

dropNontrivialIndexedStates

public void dropNontrivialIndexedStates(int inputId)

registerIndexableSet

public void registerIndexableSet(IndexableFileSet set,
                                 Project project)

Specified by:

registerIndexableSet in class FileBasedIndex

removeIndexableSet

public void removeIndexableSet(IndexableFileSet set)

Specified by:

removeIndexableSet in class FileBasedIndex

findFileById

public VirtualFile findFileById(Project project,
                                int id)

Specified by:

findFileById in class FileBasedIndex

cleanupProcessedFlag

public static void cleanupProcessedFlag()

invalidateCaches

public void invalidateCaches()

Overrides:

invalidateCaches in class FileBasedIndex

getAccessibleFileIdFilter

public java.util.function.IntPredicate getAccessibleFileIdFilter(Project project)

Specified by:

getAccessibleFileIdFilter in class FileBasedIndexEx

flushIndexes

public void flushIndexes()

isPsiDependentIndex

public static boolean isPsiDependentIndex(IndexExtension<?,?,?> extension)