Package com.intellij.openapi.roots.impl

Class ProjectFileIndexImpl

java.lang.Object

com.intellij.openapi.roots.impl.ProjectFileIndexImpl

All Implemented Interfaces:

FileIndex, ProjectFileIndex

public class ProjectFileIndexImpl
extends java.lang.Object
implements ProjectFileIndex

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.roots.ProjectFileIndex

ProjectFileIndex.SERVICE

Constructor Summary

Constructors

Constructor and Description
ProjectFileIndexImpl(Project project)
ProjectFileIndexImpl(Project project, DirectoryIndex index, FileTypeRegistry fileTypeManager) Deprecated. Do not pass DirectoryIndex explicitly.

Method Summary

Modifier and Type	Method and Description
VirtualFile	getClassRootForFile(VirtualFile file) Returns a classpath entry to which the specified file or directory belongs.
static VirtualFile	getClassRootForFile(VirtualFile file, DirectoryInfo info)
static VirtualFile	getContentRootForFile(DirectoryInfo info, VirtualFile file, boolean honorExclusion)
VirtualFile	getContentRootForFile(VirtualFile file) Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
VirtualFile	getContentRootForFile(VirtualFile file, boolean honorExclusion) Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
DirectoryInfo	getInfoForFileOrDirectory(VirtualFile file)
Module	getModuleForFile(VirtualFile file) Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
Module	getModuleForFile(VirtualFile file, boolean honorExclusion) Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
java.util.List<OrderEntry>	getOrderEntriesForFile(VirtualFile file) Returns the order entries which contain the specified file (either in CLASSES or SOURCES).
java.lang.String	getPackageNameByDirectory(VirtualFile dir) Returns the name of the package corresponding to the specified directory.
SourceFolder	getSourceFolder(VirtualFile fileOrDir)
VirtualFile	getSourceRootForFile(VirtualFile file) Returns the module source root or library source root to which the specified file or directory belongs.
static VirtualFile	getSourceRootForFile(VirtualFile file, DirectoryInfo info)
boolean	isContentSourceFile(VirtualFile file)
boolean	isExcluded(VirtualFile file) Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is either excluded from the project or ignored by FileTypeRegistry.isFileIgnored(VirtualFile)).
static boolean	isFileInContent(VirtualFile fileOrDir, DirectoryInfo info)
boolean	isIgnored(VirtualFile file)
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.
protected boolean	isInContent(VirtualFile file, DirectoryInfo info)
boolean	isInLibrary(VirtualFile fileOrDir)
boolean	isInLibraryClasses(VirtualFile fileOrDir) Returns true if fileOrDir belongs to classes of some library which is included into dependencies of some module.
boolean	isInLibrarySource(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory from sources of some library which is included into dependencies of some module.
boolean	isInSource(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory from production/test sources of some module or sources of some library which is included into dependencies of some module.
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	isLibraryClassFile(VirtualFile file) Returns true if file is a file which belongs to the classes (not sources) of some library which is included into dependencies of some module.
protected boolean	isScopeDisposed()
boolean	isUnderIgnored(VirtualFile file) Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is ignored by FileTypeRegistry.isFileIgnored(VirtualFile)).
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 FileIndex.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 FileIndex.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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.roots.ProjectFileIndex

getInstance

Methods inherited from interface com.intellij.openapi.roots.FileIndex

isContentSourceFile, iterateContent, iterateContentUnderDirectory, iterateContentUnderDirectory

Constructor Detail

ProjectFileIndexImpl

public ProjectFileIndexImpl(Project project)

ProjectFileIndexImpl

@Deprecated
public ProjectFileIndexImpl(Project project,
                            DirectoryIndex index,
                            FileTypeRegistry fileTypeManager)

Deprecated. Do not pass DirectoryIndex explicitly.

Method Detail

iterateContent

public boolean iterateContent(ContentIterator processor,
                              VirtualFileFilter filter)

Description copied from interface: FileIndex

Same as FileIndex.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.

Specified by:

iterateContent in interface FileIndex

Returns:

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

isExcluded

public boolean isExcluded(VirtualFile file)

Description copied from interface: ProjectFileIndex

Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is either excluded from the project or ignored by FileTypeRegistry.isFileIgnored(VirtualFile)).

Specified by:

isExcluded in interface ProjectFileIndex

Returns:

true if file is excluded or ignored, false otherwise.

isUnderIgnored

public boolean isUnderIgnored(VirtualFile file)

Description copied from interface: ProjectFileIndex

Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is ignored by FileTypeRegistry.isFileIgnored(VirtualFile)).

Specified by:

isUnderIgnored in interface ProjectFileIndex

Returns:

true if file is ignored, false otherwise.

getModuleForFile

public Module getModuleForFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns module to which content the specified file belongs or null if the file does not belong to content of any module.

Specified by:

getModuleForFile in interface ProjectFileIndex

getModuleForFile

public Module getModuleForFile(VirtualFile file,
                               boolean honorExclusion)

Description copied from interface: ProjectFileIndex

Returns module to which content the specified file belongs or null if the file does not belong to content of any module.

Specified by:

getModuleForFile in interface ProjectFileIndex

honorExclusion - if false the containing module will be returned even if the file is located under a folder marked as excluded

getOrderEntriesForFile

public java.util.List<OrderEntry> getOrderEntriesForFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns the order entries which contain the specified file (either in CLASSES or SOURCES).

Specified by:

getOrderEntriesForFile in interface ProjectFileIndex

getClassRootForFile

public VirtualFile getClassRootForFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns a classpath entry to which the specified file or directory belongs.

Specified by:

getClassRootForFile in interface ProjectFileIndex

Returns:

the file for the classpath entry, or null if the file is not a compiled class file or directory belonging to a library.

getClassRootForFile

public static VirtualFile getClassRootForFile(VirtualFile file,
                                              DirectoryInfo info)

getSourceRootForFile

public VirtualFile getSourceRootForFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns the module source root or library source root to which the specified file or directory belongs.

Specified by:

getSourceRootForFile in interface ProjectFileIndex

Returns:

the file for the source root, or null if the file is not located under any of the source roots for the module.

getSourceRootForFile

public static VirtualFile getSourceRootForFile(VirtualFile file,
                                               DirectoryInfo info)

getContentRootForFile

public VirtualFile getContentRootForFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.

Specified by:

getContentRootForFile in interface ProjectFileIndex

getContentRootForFile

public VirtualFile getContentRootForFile(VirtualFile file,
                                         boolean honorExclusion)

Description copied from interface: ProjectFileIndex

Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.

Specified by:

getContentRootForFile in interface ProjectFileIndex

honorExclusion - if false the containing content root will be returned even if the file is located under a folder marked as excluded

getContentRootForFile

public static VirtualFile getContentRootForFile(DirectoryInfo info,
                                                VirtualFile file,
                                                boolean honorExclusion)

getPackageNameByDirectory

public java.lang.String getPackageNameByDirectory(VirtualFile dir)

Description copied from interface: ProjectFileIndex

Returns the name of the package corresponding to the specified directory.

Specified by:

getPackageNameByDirectory in interface ProjectFileIndex

Returns:

the package name, or null if the directory does not correspond to any package.

isLibraryClassFile

public boolean isLibraryClassFile(VirtualFile file)

Description copied from interface: ProjectFileIndex

Returns true if file is a file which belongs to the classes (not sources) of some library which is included into dependencies of some module.

Specified by:

isLibraryClassFile in interface ProjectFileIndex

isInSource

public boolean isInSource(VirtualFile fileOrDir)

Description copied from interface: ProjectFileIndex

Returns true if fileOrDir is a file or directory from production/test sources of some module or sources of some library which is included into dependencies of some module.

Specified by:

isInSource in interface ProjectFileIndex

isInLibraryClasses

public boolean isInLibraryClasses(VirtualFile fileOrDir)

Description copied from interface: ProjectFileIndex

Returns true if fileOrDir belongs to classes of some library which is included into dependencies of some module.

Specified by:

isInLibraryClasses in interface ProjectFileIndex

isInLibrarySource

public boolean isInLibrarySource(VirtualFile fileOrDir)

Description copied from interface: ProjectFileIndex

Returns true if fileOrDir is a file or directory from sources of some library which is included into dependencies of some module.

Specified by:

isInLibrarySource in interface ProjectFileIndex

isInLibrary

public boolean isInLibrary(VirtualFile fileOrDir)

Specified by:

isInLibrary in interface ProjectFileIndex

Returns:

true if the file belongs to the classes or sources of a library added to dependencies of the project, false otherwise

isIgnored

public boolean isIgnored(VirtualFile file)

Specified by:

isIgnored in interface ProjectFileIndex

isInContent

public boolean isInContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

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

Specified by:

isInContent in interface FileIndex

isFileInContent

public static boolean isFileInContent(VirtualFile fileOrDir,
                                      DirectoryInfo info)

isInSourceContent

public boolean isInSourceContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

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

Specified by:

isInSourceContent in interface FileIndex

isInTestSourceContent

public boolean isInTestSourceContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

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 FileIndex.isInTestSourceContent(VirtualFile) invocation.

Specified by:

isInTestSourceContent in interface FileIndex

See Also:

TestSourcesFilter.isTestSources(VirtualFile, Project)

isUnderSourceRootOfType

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

Description copied from interface: FileIndex

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

Specified by:

isUnderSourceRootOfType in interface FileIndex

getSourceFolder

public SourceFolder getSourceFolder(VirtualFile fileOrDir)

Specified by:

getSourceFolder in interface ProjectFileIndex

isScopeDisposed

protected boolean isScopeDisposed()

iterateContent

public boolean iterateContent(ContentIterator processor)

Description copied from interface: FileIndex

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

Specified by:

iterateContent in interface FileIndex

Returns:

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

iterateContentUnderDirectory

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

Description copied from interface: FileIndex

Same as FileIndex.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.

Specified by:

iterateContentUnderDirectory in interface FileIndex

iterateContentUnderDirectory

public boolean iterateContentUnderDirectory(VirtualFile dir,
                                            ContentIterator processor)

Description copied from interface: FileIndex

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.

Specified by:

iterateContentUnderDirectory in interface FileIndex

Returns:

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

getInfoForFileOrDirectory

public DirectoryInfo getInfoForFileOrDirectory(VirtualFile file)

isContentSourceFile

public boolean isContentSourceFile(VirtualFile file)

Specified by:

isContentSourceFile in interface FileIndex

isInContent

protected boolean isInContent(VirtualFile file,
                              DirectoryInfo info)