Package com.intellij.openapi.roots

Class FileIndexFacade

java.lang.Object

com.intellij.openapi.roots.FileIndexFacade

Direct Known Subclasses:

MockFileIndexFacade, ProjectFileIndexFacade

public abstract class FileIndexFacade
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileIndexFacade(Project project)

Method Summary

Modifier and Type	Method and Description
static FileIndexFacade	getInstance(Project project)
abstract Module	getModuleForFile(VirtualFile file)
abstract ModificationTracker	getRootModificationTracker()
abstract java.util.Collection<UnloadedModuleDescription>	getUnloadedModuleDescriptions()
abstract boolean	isExcludedFile(VirtualFile file)
abstract boolean	isInContent(VirtualFile file)
abstract boolean	isInLibraryClasses(VirtualFile file)
abstract boolean	isInLibrarySource(VirtualFile file)
boolean	isInProjectScope(VirtualFile file)
abstract boolean	isInSource(VirtualFile file)
abstract boolean	isInSourceContent(VirtualFile file)
abstract boolean	isUnderIgnored(VirtualFile file)
abstract boolean	isValidAncestor(VirtualFile baseDir, VirtualFile child) Checks if file is an ancestor of baseDir and none of the files between them are excluded from the project.
boolean	shouldBeFound(GlobalSearchScope scope, VirtualFile virtualFile) Deprecated. always returns true, just remove the calls

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

Constructor Detail

FileIndexFacade

protected FileIndexFacade(Project project)

Method Detail

getInstance

public static FileIndexFacade getInstance(Project project)

isInContent

public abstract boolean isInContent(VirtualFile file)

isInSource

public abstract boolean isInSource(VirtualFile file)

isInSourceContent

public abstract boolean isInSourceContent(VirtualFile file)

isInLibraryClasses

public abstract boolean isInLibraryClasses(VirtualFile file)

isInLibrarySource

public abstract boolean isInLibrarySource(VirtualFile file)

isExcludedFile

public abstract boolean isExcludedFile(VirtualFile file)

isUnderIgnored

public abstract boolean isUnderIgnored(VirtualFile file)

getModuleForFile

public abstract Module getModuleForFile(VirtualFile file)

isValidAncestor

public abstract boolean isValidAncestor(VirtualFile baseDir,
                                        VirtualFile child)

Checks if file is an ancestor of baseDir and none of the files between them are excluded from the project.

Parameters:

baseDir - the parent directory to check for ancestry.

child - the child directory or file to check for ancestry.

Returns:

true if it's a valid ancestor, false otherwise.

shouldBeFound

@Deprecated
public boolean shouldBeFound(GlobalSearchScope scope,
                             VirtualFile virtualFile)

Deprecated. always returns true, just remove the calls

getRootModificationTracker

public abstract ModificationTracker getRootModificationTracker()

getUnloadedModuleDescriptions

public abstract java.util.Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions()

Returns:

descriptions of all modules which are unloaded from the project

See Also:

UnloadedModuleDescription

isInProjectScope

public boolean isInProjectScope(VirtualFile file)

Returns:

true if the file is isInContent(com.intellij.openapi.vfs.VirtualFile) except when it's in isInLibraryClasses(com.intellij.openapi.vfs.VirtualFile) and not in isInLibrarySource(com.intellij.openapi.vfs.VirtualFile)