Package com.intellij.openapi.roots

Interface FileIndex

All Known Subinterfaces:

ModuleFileIndex, ProjectFileIndex

All Known Implementing Classes:

ModuleFileIndexImpl, ProjectFileIndexImpl

public interface FileIndex

Provides information about files contained in a project or module. In this interface and its inheritors, methods checking specific file status ("isX", "getX") should be used from a read action. Iteration methods ("iterateX") may be called outside of a read action (since iteration can take a long time), but they should be prepared to project model being changed in the middle of the iteration.

See Also:

ProjectRootManager.getFileIndex(), ModuleRootManager.getFileIndex()

Method Summary

Modifier and Type	Method and Description
boolean	isContentSourceFile(VirtualFile file) Deprecated. name of this method is unclear, use isInSourceContent(VirtualFile) instead and add !file.isDirectory() check if you want to accept files only.
boolean	isInContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory under a content root of this project or module and not excluded or ignored.
boolean	isInSourceContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory located under a sources, tests or resources root and not excluded or ignored.
boolean	isInTestSourceContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory located under a test sources or resources root and not excluded or ignored.
boolean	isUnderSourceRootOfType(VirtualFile fileOrDir, java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes) Returns true if fileOrDir is a file or directory located under a source root of type from rootTypes set and not excluded or ignored
boolean	iterateContent(ContentIterator processor) Processes all files and directories under content roots skipping excluded and ignored files and directories.
boolean	iterateContent(ContentIterator processor, VirtualFileFilter filter) Same as iterateContent(ContentIterator) but allows to pass filter to provide filtering in condition for directories.
boolean	iterateContentUnderDirectory(VirtualFile dir, ContentIterator processor) Processes all files and directories in the content under directory dir (including the directory itself) skipping excluded and ignored files and directories.
boolean	iterateContentUnderDirectory(VirtualFile dir, ContentIterator processor, VirtualFileFilter customFilter) Same as iterateContentUnderDirectory(VirtualFile, ContentIterator) but allows to pass additional customFilter to the iterator, in case you need to skip some file system branches using your own logic.

Method Detail

iterateContent

boolean iterateContent(ContentIterator processor)

Processes all files and directories under content roots skipping excluded and ignored files and directories.

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

iterateContent

boolean iterateContent(ContentIterator processor,
                       VirtualFileFilter filter)

Same as iterateContent(ContentIterator) but allows to pass filter to provide filtering in condition for directories.

If filter returns false on a directory, the directory won't be processed, but iteration will go on.

null filter means that all directories should be processed.

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

iterateContentUnderDirectory

boolean iterateContentUnderDirectory(VirtualFile dir,
                                     ContentIterator processor)

Processes all files and directories in the content under directory dir (including the directory itself) skipping excluded and ignored files and directories. Does nothing if dir is not in the content.

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

iterateContentUnderDirectory

boolean iterateContentUnderDirectory(VirtualFile dir,
                                     ContentIterator processor,
                                     VirtualFileFilter customFilter)

Same as iterateContentUnderDirectory(VirtualFile, ContentIterator) but allows to pass additional customFilter to the iterator, in case you need to skip some file system branches using your own logic. If customFilter returns false on a directory, it won't be processed, but iteration will go on.

null filter means that all directories should be processed.

isInContent

boolean isInContent(VirtualFile fileOrDir)

Returns true if fileOrDir is a file or directory under a content root of this project or module and not excluded or ignored.

isContentSourceFile

@Deprecated
boolean isContentSourceFile(VirtualFile file)

Deprecated. name of this method is unclear, use isInSourceContent(VirtualFile) instead and add !file.isDirectory() check if you want to accept files only.

isInSourceContent

boolean isInSourceContent(VirtualFile fileOrDir)

Returns true if fileOrDir is a file or directory located under a sources, tests or resources root and not excluded or ignored.

isInTestSourceContent

boolean isInTestSourceContent(VirtualFile fileOrDir)

Returns true if fileOrDir is a file or directory located under a test sources or resources root and not excluded or ignored.

Use this method when you really need to check whether the file is under test roots according to project configuration.

If you want to determine whether file should be considered as test (e.g. for implementing SearchScope) you'd better use TestSourcesFilter.isTestSources(VirtualFile, Project) instead which includes isInTestSourceContent(VirtualFile) invocation.

See Also:

TestSourcesFilter.isTestSources(VirtualFile, Project)

isUnderSourceRootOfType

boolean isUnderSourceRootOfType(VirtualFile fileOrDir,
                                java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)

Returns true if fileOrDir is a file or directory located under a source root of type from rootTypes set and not excluded or ignored