Package com.intellij.util.indexing

Class FileBasedIndexEx

java.lang.Object

com.intellij.util.indexing.FileBasedIndex

com.intellij.util.indexing.FileBasedIndexEx

Direct Known Subclasses:

FileBasedIndexImpl

public abstract class FileBasedIndexEx
extends FileBasedIndex

Nested Class Summary

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

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

Field Summary

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

ourEnableTracingOfKeyHashToVirtualFileMapping, ourSnapshotMappingsEnabled

Constructor Summary

Constructors

Constructor and Description
FileBasedIndexEx()

Method Summary

Modifier and Type	Method and Description
<K> void	ensureUpToDate(ID<K,?> indexId, Project project, GlobalSearchScope filter) DO NOT CALL DIRECTLY IN CLIENT CODE The method is internal to indexing engine end is called internally.
abstract <K> boolean	ensureUpToDate(ID<K,?> indexId, Project project, GlobalSearchScope filter, VirtualFile restrictedFile)
abstract java.util.function.IntPredicate	getAccessibleFileIdFilter(Project project)
<K> java.util.Collection<K>	getAllKeys(ID<K,?> indexId, Project project) It is guaranteed to return data which is up-to-date within the given project.
<K,V> java.util.Collection<VirtualFile>	getContainingFiles(ID<K,V> indexId, K dataKey, GlobalSearchScope filter)
<K,V> java.util.Map<K,V>	getFileData(ID<K,V> id, VirtualFile virtualFile, Project project)
<K,V> boolean	getFilesWithKey(ID<K,V> indexId, java.util.Set<? extends K> dataKeys, Processor<? super VirtualFile> processor, GlobalSearchScope filter)
<K,V> long	getIndexModificationStamp(ID<K,V> indexId, Project project)
java.util.List<IndexableFilesProvider>	getOrderedIndexableFilesProviders(Project project, ProgressIndicator indicator) Returns providers of files to be indexed.
<K,V> java.util.List<V>	getValues(ID<K,V> indexId, K dataKey, GlobalSearchScope filter)
void	iterateIndexableFiles(ContentIterator processor, Project project, ProgressIndicator indicator)
<K> boolean	processAllKeys(ID<K,?> indexId, Processor<? super K> processor, GlobalSearchScope scope, IdFilter idFilter)
<K> boolean	processAllKeys(ID<K,?> indexId, Processor<? super K> processor, Project project) It is guaranteed to return data which is up-to-date within the given project.
<K,V> boolean	processFilesContainingAllKeys(ID<K,V> indexId, java.util.Collection<? extends K> dataKeys, GlobalSearchScope filter, Condition<? super V> valueChecker, Processor<? super VirtualFile> processor)
<K,V> boolean	processValues(ID<K,V> indexId, K dataKey, VirtualFile inFile, FileBasedIndex.ValueProcessor<? super V> processor, GlobalSearchScope filter)
<K,V> boolean	processValues(ID<K,V> indexId, K dataKey, VirtualFile inFile, FileBasedIndex.ValueProcessor<? super V> processor, GlobalSearchScope filter, IdFilter idFilter)
abstract ProjectIndexableFilesFilter	projectIndexableFiles(Project project)
<K> void	scheduleRebuild(ID<K,?> indexId, java.lang.Throwable e)

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

findFileById, getCurrentDumbModeAccessType, getFileBeingCurrentlyIndexed, getFileId, getInstance, ignoreDumbMode, invalidateCaches, isIndexAccessDuringDumbModeEnabled, iterateRecursively, registerIndexableSet, removeIndexableSet, requestRebuild, requestRebuild, requestReindex

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedIndexEx

public FileBasedIndexEx()

Method Detail

getAccessibleFileIdFilter

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

projectIndexableFiles

public abstract ProjectIndexableFilesFilter projectIndexableFiles(Project project)

ensureUpToDate

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

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.

getValues

public <K,V> java.util.List<V> getValues(ID<K,V> indexId,
                                         K dataKey,
                                         GlobalSearchScope filter)

Specified by:

getValues in class FileBasedIndex

getAllKeys

public <K> java.util.Collection<K> getAllKeys(ID<K,?> indexId,
                                              Project project)

Description copied from class: FileBasedIndex

It is guaranteed to return data which is up-to-date within the given project. Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist.

Specified by:

getAllKeys in class FileBasedIndex

processAllKeys

public <K> boolean processAllKeys(ID<K,?> indexId,
                                  Processor<? super K> processor,
                                  Project project)

Description copied from class: FileBasedIndex

It is guaranteed to return data which is up-to-date within the given project.

Specified by:

processAllKeys in class FileBasedIndex

processAllKeys

public <K> boolean processAllKeys(ID<K,?> indexId,
                                  Processor<? super K> processor,
                                  GlobalSearchScope scope,
                                  IdFilter idFilter)

Overrides:

processAllKeys in class FileBasedIndex

getFileData

public <K,V> java.util.Map<K,V> getFileData(ID<K,V> id,
                                            VirtualFile virtualFile,
                                            Project project)

Specified by:

getFileData in class FileBasedIndex

getContainingFiles

public <K,V> java.util.Collection<VirtualFile> getContainingFiles(ID<K,V> indexId,
                                                                  K dataKey,
                                                                  GlobalSearchScope filter)

Specified by:

getContainingFiles in class FileBasedIndex

processValues

public <K,V> boolean processValues(ID<K,V> indexId,
                                   K dataKey,
                                   VirtualFile inFile,
                                   FileBasedIndex.ValueProcessor<? super V> processor,
                                   GlobalSearchScope filter)

Specified by:

processValues in class FileBasedIndex

Returns:

false if ValueProcessor.process() returned false; true otherwise or if ValueProcessor was not called at all

processValues

public <K,V> boolean processValues(ID<K,V> indexId,
                                   K dataKey,
                                   VirtualFile inFile,
                                   FileBasedIndex.ValueProcessor<? super V> processor,
                                   GlobalSearchScope filter,
                                   IdFilter idFilter)

Overrides:

processValues in class FileBasedIndex

Returns:

false if ValueProcessor.process() returned false; true otherwise or if ValueProcessor was not called at all

getIndexModificationStamp

public <K,V> long getIndexModificationStamp(ID<K,V> indexId,
                                            Project project)

Specified by:

getIndexModificationStamp in class FileBasedIndex

processFilesContainingAllKeys

public <K,V> boolean processFilesContainingAllKeys(ID<K,V> indexId,
                                                   java.util.Collection<? extends K> dataKeys,
                                                   GlobalSearchScope filter,
                                                   Condition<? super V> valueChecker,
                                                   Processor<? super VirtualFile> processor)

Specified by:

processFilesContainingAllKeys in class FileBasedIndex

getFilesWithKey

public <K,V> boolean getFilesWithKey(ID<K,V> indexId,
                                     java.util.Set<? extends K> dataKeys,
                                     Processor<? super VirtualFile> processor,
                                     GlobalSearchScope filter)

Specified by:

getFilesWithKey in class FileBasedIndex

scheduleRebuild

public <K> void scheduleRebuild(ID<K,?> indexId,
                                java.lang.Throwable e)

Specified by:

scheduleRebuild in class FileBasedIndex

ensureUpToDate

public <K> void ensureUpToDate(ID<K,?> indexId,
                               Project project,
                               GlobalSearchScope filter)

DO NOT CALL DIRECTLY IN CLIENT CODE The method is internal to indexing engine end is called internally. The method is public due to implementation details

Specified by:

ensureUpToDate in class FileBasedIndex

iterateIndexableFiles

public void iterateIndexableFiles(ContentIterator processor,
                                  Project project,
                                  ProgressIndicator indicator)

Specified by:

iterateIndexableFiles in class FileBasedIndex

getOrderedIndexableFilesProviders

public java.util.List<IndexableFilesProvider> getOrderedIndexableFilesProviders(Project project,
                                                                                ProgressIndicator indicator)

Returns providers of files to be indexed. Indexing is performed in the order corresponding to the resulting list.