Package com.intellij.psi.search.searches

Class ReferencesSearch

java.lang.Object

com.intellij.util.QueryFactory<Result,Parameters>

com.intellij.psi.search.searches.ExtensibleQueryFactory<PsiReference,ReferencesSearch.SearchParameters>

com.intellij.psi.search.searches.ReferencesSearch

public class ReferencesSearch
extends ExtensibleQueryFactory<PsiReference,ReferencesSearch.SearchParameters>

Locates all references to a specified PSI element.

See Also:

PsiReference, ReferenceSearcher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReferencesSearch.SearchParameters

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<QueryExecutor<PsiReference,ReferencesSearch.SearchParameters>>	EP_NAME

Method Summary

Modifier and Type	Method and Description
static Query<PsiReference>	search(PsiElement element) Searches for references to the specified element in the scope in which such references are expected to be found, according to dependencies and access rules.
static Query<PsiReference>	search(PsiElement element, SearchScope searchScope) Searches for references to the specified element in the specified scope.
static Query<PsiReference>	search(PsiElement element, SearchScope searchScope, boolean ignoreAccessScope) Searches for references to the specified element in the specified scope, optionally returning also references which are invalid because of access rules (e.g.
static Query<PsiReference>	search(ReferencesSearch.SearchParameters parameters) Searches for references to the specified element according to the specified parameters.
static void	searchOptimized(PsiElement element, SearchScope searchScope, boolean ignoreAccessScope, SearchRequestCollector collector, boolean inReadAction, PairProcessor<? super PsiReference,? super SearchRequestCollector> processor)
static void	searchOptimized(PsiElement element, SearchScope searchScope, boolean ignoreAccessScope, SearchRequestCollector collector, Processor<? super PsiReference> processor)

Methods inherited from class com.intellij.psi.search.searches.ExtensibleQueryFactory

getExecutors, registerExecutor, registerExecutor, unregisterExecutor

Methods inherited from class com.intellij.util.QueryFactory

createQuery, createUniqueResultsQuery, createUniqueResultsQuery, createUniqueResultsQuery, hasAnyExecutors

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<QueryExecutor<PsiReference,ReferencesSearch.SearchParameters>> EP_NAME

Method Detail

search

public static Query<PsiReference> search(PsiElement element)

Searches for references to the specified element in the scope in which such references are expected to be found, according to dependencies and access rules.

Parameters:

element - the element (declaration) the references to which are requested.

Returns:

the query allowing to enumerate the references.

search

public static Query<PsiReference> search(PsiElement element,
                                         SearchScope searchScope)

Searches for references to the specified element in the specified scope.

Parameters:

element - the element (declaration) the references to which are requested.

searchScope - the scope in which the search is performed.

Returns:

the query allowing to enumerate the references.

search

public static Query<PsiReference> search(PsiElement element,
                                         SearchScope searchScope,
                                         boolean ignoreAccessScope)

Searches for references to the specified element in the specified scope, optionally returning also references which are invalid because of access rules (e.g. references to a private method from a different class).

Parameters:

element - the element (declaration) the references to which are requested.

searchScope - the scope in which the search is performed.

ignoreAccessScope - if true, references which are invalid because of access rules are included in the results.

Returns:

the query allowing to enumerate the references.

search

public static Query<PsiReference> search(ReferencesSearch.SearchParameters parameters)

Searches for references to the specified element according to the specified parameters.

Parameters:

parameters - the parameters for the search (contain also the element the references to which are requested).

Returns:

the query allowing to enumerate the references.

searchOptimized

public static void searchOptimized(PsiElement element,
                                   SearchScope searchScope,
                                   boolean ignoreAccessScope,
                                   SearchRequestCollector collector,
                                   Processor<? super PsiReference> processor)

searchOptimized

public static void searchOptimized(PsiElement element,
                                   SearchScope searchScope,
                                   boolean ignoreAccessScope,
                                   SearchRequestCollector collector,
                                   boolean inReadAction,
                                   PairProcessor<? super PsiReference,? super SearchRequestCollector> processor)