Package com.intellij.psi.search

Class ProjectAndLibrariesScope

java.lang.Object

com.intellij.psi.search.SearchScope

com.intellij.psi.search.GlobalSearchScope

com.intellij.psi.search.ProjectAndLibrariesScope

All Implemented Interfaces:

VirtualFileFilter, ProjectAwareFileFilter

public class ProjectAndLibrariesScope
extends GlobalSearchScope

Scope for all things inside the project: files in the project content plus files in libraries/libraries sources

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.search.GlobalSearchScope

GlobalSearchScope.FilesScope

Field Summary

Fields

Modifier and Type	Field and Description
protected ProjectFileIndex	myProjectFileIndex

Fields inherited from class com.intellij.psi.search.GlobalSearchScope

EMPTY_ARRAY, EMPTY_SCOPE

Fields inherited from interface com.intellij.openapi.vfs.VirtualFileFilter

ALL, NONE

Constructor Summary

Constructors

Constructor and Description
ProjectAndLibrariesScope(Project project)
ProjectAndLibrariesScope(Project project, boolean searchOutsideRootModel) Deprecated. use ProjectAndLibrariesScope(Project)

Method Summary

Modifier and Type	Method and Description
int	compare(VirtualFile file1, VirtualFile file2)
boolean	contains(VirtualFile file)
java.lang.String	getDisplayName()
java.util.Collection<UnloadedModuleDescription>	getUnloadedModulesBelongingToScope() Returns descriptions of unloaded modules content of whose might be included into this scope if they had been loaded.
boolean	isSearchInLibraries()
boolean	isSearchInModuleContent(Module aModule)
void	setDisplayName(java.lang.String displayName)
java.lang.String	toString()

Methods inherited from class com.intellij.psi.search.GlobalSearchScope

accept, allScope, everythingScope, fileScope, fileScope, fileScope, filesScope, filesScope, filesWithLibrariesScope, filesWithoutLibrariesScope, getProject, getScopeRestrictedByFileTypes, intersectWith, intersectWith, intersectWith, isForceSearchingInLibrarySources, isSearchInModuleContent, moduleRuntimeScope, moduleScope, moduleTestsWithDependentsScope, moduleWithDependenciesAndLibrariesScope, moduleWithDependenciesAndLibrariesScope, moduleWithDependenciesScope, moduleWithDependentsScope, moduleWithLibrariesScope, notScope, projectScope, union, union, union, union, uniteWith

Methods inherited from class com.intellij.psi.search.SearchScope

calcHashCode, getIcon, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.vfs.VirtualFileFilter

and

Field Detail

myProjectFileIndex

protected final ProjectFileIndex myProjectFileIndex

Constructor Detail

ProjectAndLibrariesScope

public ProjectAndLibrariesScope(Project project)

ProjectAndLibrariesScope

@Deprecated
public ProjectAndLibrariesScope(Project project,
                                boolean searchOutsideRootModel)

Deprecated. use ProjectAndLibrariesScope(Project)

Method Detail

contains

public boolean contains(VirtualFile file)

Specified by:

contains in class SearchScope

compare

public int compare(VirtualFile file1,
                   VirtualFile file2)

Overrides:

compare in class GlobalSearchScope

Returns:

• a positive integer (e.g. +1), if file1 is located in the classpath before file2
• a negative integer (e.e -1), if file1 is located in the classpath after file2
• zero - otherwise or when the files are not comparable

isSearchInModuleContent

public boolean isSearchInModuleContent(Module aModule)

Specified by:

isSearchInModuleContent in class GlobalSearchScope

isSearchInLibraries

public boolean isSearchInLibraries()

Specified by:

isSearchInLibraries in class GlobalSearchScope

getUnloadedModulesBelongingToScope

public java.util.Collection<UnloadedModuleDescription> getUnloadedModulesBelongingToScope()

Description copied from class: GlobalSearchScope

Returns descriptions of unloaded modules content of whose might be included into this scope if they had been loaded. Actually search in unloaded modules isn't performed, so this method is used to determine whether a warning about possible missing results should be shown.

Overrides:

getUnloadedModulesBelongingToScope in class GlobalSearchScope

getDisplayName

public java.lang.String getDisplayName()

Overrides:

getDisplayName in class SearchScope

setDisplayName

public void setDisplayName(java.lang.String displayName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object