ProjectFileIndex (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

FileIndex

All Known Implementing Classes:

ProjectFileIndexImpl
```
public interface ProjectFileIndex
extends FileIndex
```
Provides information about files contained in a project. Should be used from a read action.

See Also:

ProjectRootManager.getFileIndex()

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ProjectFileIndex.SERVICE

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ProjectFileIndex.SERVICE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`VirtualFile`	`getClassRootForFile(VirtualFile file)` Returns a classpath entry to which the specified file or directory belongs.
`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.
`static ProjectFileIndex`	`getInstance(Project project)`
`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.
`default 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.
`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)`).
`boolean`	`isIgnored(VirtualFile file)` Deprecated. name of this method may be confusing. If you want to check if the file is excluded or ignored use `isExcluded(VirtualFile)`. If you want to check if the file is ignored use `FileTypeRegistry.isFileIgnored(VirtualFile)`. If you want to check if the file or one of its parents is ignored use `isUnderIgnored(VirtualFile)`.
`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`	`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.
`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)`).

Methods inherited from interface com.intellij.openapi.roots.FileIndex
isContentSourceFile, isInContent, isInSourceContent, isInTestSourceContent, isUnderSourceRootOfType, iterateContent, iterateContent, iterateContentUnderDirectory, iterateContentUnderDirectory

- Method Detail
  - getInstance
```
static ProjectFileIndex getInstance(Project project)
```
  - getModuleForFile
```
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.
  - getModuleForFile
```
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.
    
    Parameters:
    
    honorExclusion - if false the containing module will be returned even if the file is located under a folder marked as excluded
  - getOrderEntriesForFile
```
java.util.List<OrderEntry> getOrderEntriesForFile(VirtualFile file)
```
    Returns the order entries which contain the specified file (either in CLASSES or SOURCES).
  - getClassRootForFile
```
VirtualFile getClassRootForFile(VirtualFile file)
```
    Returns a classpath entry to which the specified file or directory belongs.
    
    Returns:
    
    the file for the classpath entry, or null if the file is not a compiled class file or directory belonging to a library.
  - getSourceRootForFile
```
VirtualFile getSourceRootForFile(VirtualFile file)
```
    Returns the module source root or library source root to which the specified file or directory belongs.
    
    Returns:
    
    the file for the source root, or null if the file is not located under any of the source roots for the module.
  - getContentRootForFile
```
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.
  - getContentRootForFile
```
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.
    
    Parameters:
    
    honorExclusion - if false the containing content root will be returned even if the file is located under a folder marked as excluded
  - getPackageNameByDirectory
```
java.lang.String getPackageNameByDirectory(VirtualFile dir)
```
    Returns the name of the package corresponding to the specified directory.
    
    Returns:
    
    the package name, or null if the directory does not correspond to any package.
  - isLibraryClassFile
```
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.
  - isInSource
```
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.
  - isInLibraryClasses
```
boolean isInLibraryClasses(VirtualFile fileOrDir)
```
    Returns true if fileOrDir belongs to classes of some library which is included into dependencies of some module.
  - isInLibrary
```
boolean isInLibrary(VirtualFile fileOrDir)
```
    Returns:
    
    true if the file belongs to the classes or sources of a library added to dependencies of the project, false otherwise
  - isInLibrarySource
```
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.
  - isIgnored
```
@Deprecated
boolean isIgnored(VirtualFile file)
```
    Deprecated. name of this method may be confusing. If you want to check if the file is excluded or ignored use isExcluded(VirtualFile). If you want to check if the file is ignored use FileTypeRegistry.isFileIgnored(VirtualFile). If you want to check if the file or one of its parents is ignored use isUnderIgnored(VirtualFile).
  - isExcluded
```
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)).
    
    Returns:
    
    true if file is excluded or ignored, false otherwise.
  - isUnderIgnored
```
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)).
    
    Returns:
    
    true if file is ignored, false otherwise.
  - getSourceFolder
```
default SourceFolder getSourceFolder(VirtualFile fileOrDir)
```

Interface ProjectFileIndex

Nested Class Summary

Method Summary

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

Method Detail

getInstance

getModuleForFile

getModuleForFile

getOrderEntriesForFile

getClassRootForFile

getSourceRootForFile

getContentRootForFile

getContentRootForFile

getPackageNameByDirectory

isLibraryClassFile

isInSource

isInLibraryClasses

isInLibrary

isInLibrarySource

isIgnored

isExcluded

isUnderIgnored

getSourceFolder