Package com.intellij.util.indexing.roots

Interface IndexableFilesProvider

public interface IndexableFilesProvider

Provides files to be indexed for a project structure entity (module, library, SDK, etc.) Allows the indexing infrastructure to prioritize indexing by some predicate.

See Also:

[ModuleIndexableFilesProvider], [LibraryIndexableFilesProvider]

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIndexingProgressText() Presentable text shown in progress indicator during indexing of files of this provider.
java.lang.String	getRootsScanningProgressText() Presentable text shown in progress indicator during traversing of files of this provider.
boolean	iterateFiles(Project project, ContentIterator fileIterator, ConcurrentBitSet visitedFileSet) Iterates through all files and directories corresponding to this provider.

Method Detail

getIndexingProgressText

java.lang.String getIndexingProgressText()

Presentable text shown in progress indicator during indexing of files of this provider.

getRootsScanningProgressText

java.lang.String getRootsScanningProgressText()

Presentable text shown in progress indicator during traversing of files of this provider.

iterateFiles

boolean iterateFiles(Project project,
                     ContentIterator fileIterator,
                     ConcurrentBitSet visitedFileSet)

Iterates through all files and directories corresponding to this provider. Skips already visited files by looking to [visitedFileSet].

Returns:

`false` if [fileIterator] has stopped iteration by returning `false`, `true` otherwise.