Package com.intellij.psi.search.searches

Class ReferencesSearch.SearchParameters

java.lang.Object

com.intellij.psi.search.searches.ReferencesSearch.SearchParameters

All Implemented Interfaces:

SearchParameters<PsiReference>, DumbAwareSearchParameters, QueryParameters

Enclosing class:

ReferencesSearch

public static class ReferencesSearch.SearchParameters
extends java.lang.Object
implements DumbAwareSearchParameters, SearchParameters<PsiReference>

Constructor Summary

Constructors

Constructor and Description
SearchParameters(PsiElement elementToSearch, SearchScope scope, boolean ignoreAccessScope)
SearchParameters(PsiElement elementToSearch, SearchScope scope, boolean ignoreAccessScope, SearchRequestCollector optimizer)

Method Summary

Modifier and Type	Method and Description
boolean	areValid()
SearchScope	getEffectiveSearchScope()
PsiElement	getElementToSearch()
SearchRequestCollector	getOptimizer()
Project	getProject()
SearchScope	getScope() Deprecated. Same as getScopeDeterminedByUser(), use getEffectiveSearchScope() instead
SearchScope	getScopeDeterminedByUser()
boolean	isIgnoreAccessScope()
boolean	isQueryValid()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchParameters

public SearchParameters(PsiElement elementToSearch,
                        SearchScope scope,
                        boolean ignoreAccessScope,
                        SearchRequestCollector optimizer)

SearchParameters

public SearchParameters(PsiElement elementToSearch,
                        SearchScope scope,
                        boolean ignoreAccessScope)

Method Detail

areValid

public final boolean areValid()

Specified by:

areValid in interface SearchParameters<PsiReference>

isQueryValid

public boolean isQueryValid()

Specified by:

isQueryValid in interface QueryParameters

Returns:

whether this query still makes sense (e.g. PSI inside is still valid)

getProject

public Project getProject()

Specified by:

getProject in interface SearchParameters<PsiReference>

Specified by:

getProject in interface DumbAwareSearchParameters

Specified by:

getProject in interface QueryParameters

getElementToSearch

public PsiElement getElementToSearch()

getScopeDeterminedByUser

public SearchScope getScopeDeterminedByUser()

Returns:

the user-visible search scope, most often "Project Files" or "Project and Libraries". Searchers most likely need to use getEffectiveSearchScope().

getScope

@Deprecated
public SearchScope getScope()

Deprecated. Same as getScopeDeterminedByUser(), use getEffectiveSearchScope() instead

isIgnoreAccessScope

public boolean isIgnoreAccessScope()

getOptimizer

public SearchRequestCollector getOptimizer()

getEffectiveSearchScope

public SearchScope getEffectiveSearchScope()