Package com.intellij.util.indexing

Class FileBasedIndex

java.lang.Object

com.intellij.util.indexing.FileBasedIndex

Direct Known Subclasses:

FileBasedIndexEx

public abstract class FileBasedIndex
extends java.lang.Object

See Also:

FileBasedIndexExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileBasedIndex.FileTypeSpecificInputFilter
static interface	FileBasedIndex.InputFilter
static interface	FileBasedIndex.ValueProcessor<V>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ourEnableTracingOfKeyHashToVirtualFileMapping Deprecated. inline true
static boolean	ourSnapshotMappingsEnabled

Constructor Summary

Constructors

Constructor and Description
FileBasedIndex()

Method Summary

Modifier and Type	Method and Description
abstract <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 VirtualFile	findFileById(Project project, int id) Deprecated. see ManagingFS.findFileById(int)
abstract <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.
abstract <K,V> java.util.Collection<VirtualFile>	getContainingFiles(ID<K,V> indexId, K dataKey, GlobalSearchScope filter)
DumbModeAccessType	getCurrentDumbModeAccessType()
abstract VirtualFile	getFileBeingCurrentlyIndexed()
abstract <K,V> java.util.Map<K,V>	getFileData(ID<K,V> id, VirtualFile virtualFile, Project project)
static int	getFileId(VirtualFile file)
abstract <K,V> boolean	getFilesWithKey(ID<K,V> indexId, java.util.Set<? extends K> dataKeys, Processor<? super VirtualFile> processor, GlobalSearchScope filter)
abstract <K,V> long	getIndexModificationStamp(ID<K,V> indexId, Project project)
static FileBasedIndex	getInstance()
abstract <K,V> java.util.List<V>	getValues(ID<K,V> indexId, K dataKey, GlobalSearchScope filter)
void	ignoreDumbMode(java.lang.Runnable command, Project project, DumbModeAccessType dumbModeAccessType) Executes command and allow its to have an index access in dumb mode.
void	invalidateCaches()
static boolean	isIndexAccessDuringDumbModeEnabled()
abstract void	iterateIndexableFiles(ContentIterator processor, Project project, ProgressIndicator indicator)
static void	iterateRecursively(VirtualFile root, ContentIterator processor, ProgressIndicator indicator, java.util.Set<? super VirtualFile> visitedRoots, ProjectFileIndex projectFileIndex)
<K> boolean	processAllKeys(ID<K,?> indexId, Processor<? super K> processor, GlobalSearchScope scope, IdFilter idFilter)
abstract <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.
abstract <K,V> boolean	processFilesContainingAllKeys(ID<K,V> indexId, java.util.Collection<? extends K> dataKeys, GlobalSearchScope filter, Condition<? super V> valueChecker, Processor<? super VirtualFile> processor)
abstract <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 void	registerIndexableSet(IndexableFileSet set, Project project)
abstract void	removeIndexableSet(IndexableFileSet set)
void	requestRebuild(ID<?,?> indexId)
abstract void	requestRebuild(ID<?,?> indexId, java.lang.Throwable throwable)
abstract void	requestReindex(VirtualFile file)
abstract <K> void	scheduleRebuild(ID<K,?> indexId, java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Field Detail

ourEnableTracingOfKeyHashToVirtualFileMapping

@Deprecated
public static final boolean ourEnableTracingOfKeyHashToVirtualFileMapping

Deprecated. inline true

See Also:

Constant Field Values

ourSnapshotMappingsEnabled

public static final boolean ourSnapshotMappingsEnabled

Constructor Detail

FileBasedIndex

public FileBasedIndex()

Method Detail

iterateIndexableFiles

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

getFileBeingCurrentlyIndexed

public abstract VirtualFile getFileBeingCurrentlyIndexed()

Returns:

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

getCurrentDumbModeAccessType

public DumbModeAccessType getCurrentDumbModeAccessType()

registerIndexableSet

public abstract void registerIndexableSet(IndexableFileSet set,
                                          Project project)

removeIndexableSet

public abstract void removeIndexableSet(IndexableFileSet set)

getInstance

public static FileBasedIndex getInstance()

getFileId

public static int getFileId(VirtualFile file)

findFileById

@Deprecated
public abstract VirtualFile findFileById(Project project,
                                         int id)

Deprecated. see ManagingFS.findFileById(int)

requestRebuild

public void requestRebuild(ID<?,?> indexId)

getValues

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

getContainingFiles

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

processValues

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

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)

Returns:

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

getIndexModificationStamp

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

processFilesContainingAllKeys

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

getAllKeys

public abstract <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. Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist.

ensureUpToDate

public abstract <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

requestRebuild

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

scheduleRebuild

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

requestReindex

public abstract void requestReindex(VirtualFile file)

getFilesWithKey

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

ignoreDumbMode

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

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

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)?

processAllKeys

public abstract <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.

processAllKeys

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

getFileData

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

iterateRecursively

public static void iterateRecursively(VirtualFile root,
                                      ContentIterator processor,
                                      ProgressIndicator indicator,
                                      java.util.Set<? super VirtualFile> visitedRoots,
                                      ProjectFileIndex projectFileIndex)

invalidateCaches

public void invalidateCaches()

isIndexAccessDuringDumbModeEnabled

public static boolean isIndexAccessDuringDumbModeEnabled()