Package com.intellij.psi.search

Class DelegatingGlobalSearchScope

java.lang.Object

com.intellij.psi.search.SearchScope

com.intellij.psi.search.GlobalSearchScope

com.intellij.psi.search.DelegatingGlobalSearchScope

All Implemented Interfaces:

VirtualFileFilter, ProjectAwareFileFilter

Direct Known Subclasses:

ExternalModuleBuildGlobalSearchScope, GrSourceFilterScope, JavaFxScopeEnlarger.GlobalFxmlSearchScope, JavaSourceFilterScope, ModuleContentRootSearchScope, StructuralSearchScriptScope

public class DelegatingGlobalSearchScope
extends GlobalSearchScope

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 GlobalSearchScope	myBaseScope

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
DelegatingGlobalSearchScope(GlobalSearchScope baseScope)
DelegatingGlobalSearchScope(GlobalSearchScope baseScope, java.lang.Object... equality)

Method Summary

Modifier and Type	Method and Description
int	calcHashCode() To provide your own hash code please override this method instead of SearchScope.hashCode() to be able to cache the computed hash code.
int	compare(VirtualFile file1, VirtualFile file2)
boolean	contains(VirtualFile file)
boolean	equals(java.lang.Object o)
java.lang.String	getDisplayName()
javax.swing.Icon	getIcon()
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)
boolean	isSearchInModuleContent(Module aModule, boolean testSources)
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, moduleRuntimeScope, moduleScope, moduleTestsWithDependentsScope, moduleWithDependenciesAndLibrariesScope, moduleWithDependenciesAndLibrariesScope, moduleWithDependenciesScope, moduleWithDependentsScope, moduleWithLibrariesScope, notScope, projectScope, union, union, union, union, uniteWith

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

hashCode

Methods inherited from class java.lang.Object

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

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

and

Field Detail

myBaseScope

protected final GlobalSearchScope myBaseScope

Constructor Detail

DelegatingGlobalSearchScope

public DelegatingGlobalSearchScope(GlobalSearchScope baseScope)

DelegatingGlobalSearchScope

public DelegatingGlobalSearchScope(GlobalSearchScope baseScope,
                                   java.lang.Object... equality)

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

isSearchInModuleContent

public boolean isSearchInModuleContent(Module aModule,
                                       boolean testSources)

Overrides:

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

getIcon

public javax.swing.Icon getIcon()

Overrides:

getIcon in class SearchScope

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

calcHashCode

public int calcHashCode()

Description copied from class: SearchScope

To provide your own hash code please override this method instead of SearchScope.hashCode() to be able to cache the computed hash code.

Overrides:

calcHashCode in class SearchScope