Package com.intellij.psi.search

Class GlobalSearchScope

java.lang.Object

com.intellij.psi.search.SearchScope

com.intellij.psi.search.GlobalSearchScope

All Implemented Interfaces:

VirtualFileFilter, ProjectAwareFileFilter

Direct Known Subclasses:

AdditionalIndexedRootsScope, CompilerReferenceServiceBase.ScopeWithoutReferencesOnCompilation, CoreProjectScopeBuilder.ContentSearchScope, DelegatingGlobalSearchScope, EverythingGlobalScope, GlobalSearchScope.FilesScope, GlobalSearchScopesCore.DirectoryScope, JavaFilesSearchScope, LibraryRuntimeClasspathScope, LibraryScopeBase, MockGlobalSearchScope, ModulesScope, ModuleWithDependenciesScope, ModuleWithDependentsScope, NonClasspathDirectoriesScope, PackageScope, ProjectAndLibrariesScope, ProjectScopeImpl, ScratchesSearchScope

public abstract class GlobalSearchScope
extends SearchScope
implements ProjectAwareFileFilter

Project model-aware search scope.

See Also:

GlobalSearchScopes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalSearchScope.FilesScope

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalSearchScope[]	EMPTY_ARRAY
static GlobalSearchScope	EMPTY_SCOPE

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

ALL, NONE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobalSearchScope()
protected	GlobalSearchScope(Project project)

Method Summary

Modifier and Type	Method and Description
boolean	accept(VirtualFile file)
static GlobalSearchScope	allScope(Project project)
int	compare(VirtualFile file1, VirtualFile file2)
static GlobalSearchScope	everythingScope(Project project)
static GlobalSearchScope	fileScope(Project project, VirtualFile virtualFile)
static GlobalSearchScope	fileScope(Project project, VirtualFile virtualFile, java.lang.String displayName)
static GlobalSearchScope	fileScope(PsiFile psiFile)
static GlobalSearchScope	filesScope(Project project, java.util.Collection<? extends VirtualFile> files) Please consider using this#filesWithLibrariesScope or this#filesWithoutLibrariesScope for optimization
static GlobalSearchScope	filesScope(Project project, java.util.Collection<? extends VirtualFile> files, java.lang.String displayName) Please consider using this#filesWithLibrariesScope or this#filesWithoutLibrariesScope for optimization
static GlobalSearchScope	filesWithLibrariesScope(Project project, java.util.Collection<? extends VirtualFile> files)
static GlobalSearchScope	filesWithoutLibrariesScope(Project project, java.util.Collection<? extends VirtualFile> files) Optimization.
Project	getProject()
static GlobalSearchScope	getScopeRestrictedByFileTypes(GlobalSearchScope scope, FileType... fileTypes)
java.util.Collection<UnloadedModuleDescription>	getUnloadedModulesBelongingToScope() Returns descriptions of unloaded modules content of whose might be included into this scope if they had been loaded.
GlobalSearchScope	intersectWith(GlobalSearchScope scope)
SearchScope	intersectWith(LocalSearchScope localScope2)
SearchScope	intersectWith(SearchScope scope2)
boolean	isForceSearchingInLibrarySources()
abstract boolean	isSearchInLibraries()
abstract boolean	isSearchInModuleContent(Module aModule)
boolean	isSearchInModuleContent(Module aModule, boolean testSources)
static GlobalSearchScope	moduleRuntimeScope(Module module, boolean includeTests)
static GlobalSearchScope	moduleScope(Module module) Returns module scope including sources and tests, excluding libraries and dependencies.
static GlobalSearchScope	moduleTestsWithDependentsScope(Module module)
static GlobalSearchScope	moduleWithDependenciesAndLibrariesScope(Module module)
static GlobalSearchScope	moduleWithDependenciesAndLibrariesScope(Module module, boolean includeTests)
static GlobalSearchScope	moduleWithDependenciesScope(Module module) Returns module scope including sources, tests, and dependencies, excluding libraries.
static GlobalSearchScope	moduleWithDependentsScope(Module module)
static GlobalSearchScope	moduleWithLibrariesScope(Module module) Returns module scope including sources, tests, and libraries, excluding dependencies.
static GlobalSearchScope	notScope(GlobalSearchScope scope)
static GlobalSearchScope	projectScope(Project project)
static GlobalSearchScope	union(java.util.Collection<? extends GlobalSearchScope> scopes)
static GlobalSearchScope	union(GlobalSearchScope [] scopes)
GlobalSearchScope	union(LocalSearchScope scope)
GlobalSearchScope	union(SearchScope scope)
GlobalSearchScope	uniteWith(GlobalSearchScope scope)

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

calcHashCode, contains, getDisplayName, getIcon, hashCode

Methods inherited from class java.lang.Object

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

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

and

Field Detail

EMPTY_ARRAY

public static final GlobalSearchScope[] EMPTY_ARRAY

EMPTY_SCOPE

public static final GlobalSearchScope EMPTY_SCOPE

Constructor Detail

GlobalSearchScope

protected GlobalSearchScope(Project project)

GlobalSearchScope

protected GlobalSearchScope()

Method Detail

getProject

public Project getProject()

Specified by:

getProject in interface ProjectAwareFileFilter

compare

public int compare(VirtualFile file1,
                   VirtualFile file2)

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 abstract boolean isSearchInModuleContent(Module aModule)

isSearchInModuleContent

public boolean isSearchInModuleContent(Module aModule,
                                       boolean testSources)

accept

public final boolean accept(VirtualFile file)

Specified by:

accept in interface VirtualFileFilter

isSearchInLibraries

public abstract boolean isSearchInLibraries()

isForceSearchingInLibrarySources

public boolean isForceSearchingInLibrarySources()

getUnloadedModulesBelongingToScope

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

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.

intersectWith

public GlobalSearchScope intersectWith(GlobalSearchScope scope)

intersectWith

public SearchScope intersectWith(SearchScope scope2)

Specified by:

intersectWith in class SearchScope

intersectWith

public SearchScope intersectWith(LocalSearchScope localScope2)

union

public GlobalSearchScope union(SearchScope scope)

Specified by:

union in class SearchScope

union

public GlobalSearchScope union(LocalSearchScope scope)

uniteWith

public GlobalSearchScope uniteWith(GlobalSearchScope scope)

union

public static GlobalSearchScope union(java.util.Collection<? extends GlobalSearchScope> scopes)

union

public static GlobalSearchScope union(GlobalSearchScope [] scopes)

allScope

public static GlobalSearchScope allScope(Project project)

projectScope

public static GlobalSearchScope projectScope(Project project)

everythingScope

public static GlobalSearchScope everythingScope(Project project)

notScope

public static GlobalSearchScope notScope(GlobalSearchScope scope)

moduleScope

public static GlobalSearchScope moduleScope(Module module)

Returns module scope including sources and tests, excluding libraries and dependencies.

Parameters:

module - the module to get the scope.

Returns:

scope including sources and tests, excluding libraries and dependencies.

moduleWithLibrariesScope

public static GlobalSearchScope moduleWithLibrariesScope(Module module)

Returns module scope including sources, tests, and libraries, excluding dependencies.

Parameters:

module - the module to get the scope.

Returns:

scope including sources, tests, and libraries, excluding dependencies.

moduleWithDependenciesScope

public static GlobalSearchScope moduleWithDependenciesScope(Module module)

Returns module scope including sources, tests, and dependencies, excluding libraries.

Parameters:

module - the module to get the scope.

Returns:

scope including sources, tests, and dependencies, excluding libraries.

moduleRuntimeScope

public static GlobalSearchScope moduleRuntimeScope(Module module,
                                                   boolean includeTests)

moduleWithDependenciesAndLibrariesScope

public static GlobalSearchScope moduleWithDependenciesAndLibrariesScope(Module module)

moduleWithDependenciesAndLibrariesScope

public static GlobalSearchScope moduleWithDependenciesAndLibrariesScope(Module module,
                                                                        boolean includeTests)

moduleWithDependentsScope

public static GlobalSearchScope moduleWithDependentsScope(Module module)

moduleTestsWithDependentsScope

public static GlobalSearchScope moduleTestsWithDependentsScope(Module module)

fileScope

public static GlobalSearchScope fileScope(PsiFile psiFile)

fileScope

public static GlobalSearchScope fileScope(Project project,
                                          VirtualFile virtualFile)

fileScope

public static GlobalSearchScope fileScope(Project project,
                                          VirtualFile virtualFile,
                                          java.lang.String displayName)

filesScope

public static GlobalSearchScope filesScope(Project project,
                                           java.util.Collection<? extends VirtualFile> files)

Please consider using this#filesWithLibrariesScope or this#filesWithoutLibrariesScope for optimization

filesWithoutLibrariesScope

public static GlobalSearchScope filesWithoutLibrariesScope(Project project,
                                                           java.util.Collection<? extends VirtualFile> files)

Optimization. By default FilesScope makes a decision about searching in libraries by checking that at least one file is placed out of module roots. So if you're sure about files placement you can explicitly say FilesScope whether it should include libraries or not in order to avoid checking each file. Also, if you have a lot of files it might be faster to always search in libraries.

filesWithLibrariesScope

public static GlobalSearchScope filesWithLibrariesScope(Project project,
                                                        java.util.Collection<? extends VirtualFile> files)

filesScope

public static GlobalSearchScope filesScope(Project project,
                                           java.util.Collection<? extends VirtualFile> files,
                                           java.lang.String displayName)

Please consider using this#filesWithLibrariesScope or this#filesWithoutLibrariesScope for optimization

getScopeRestrictedByFileTypes

public static GlobalSearchScope getScopeRestrictedByFileTypes(GlobalSearchScope scope,
                                                              FileType... fileTypes)