Package com.intellij.psi.impl.search

Class PsiSearchHelperImpl

java.lang.Object

com.intellij.psi.impl.search.PsiSearchHelperImpl

All Implemented Interfaces:

PsiSearchHelper

public class PsiSearchHelperImpl
extends java.lang.Object
implements PsiSearchHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsiSearchHelperImpl.Options

Nested classes/interfaces inherited from interface com.intellij.psi.search.PsiSearchHelper

PsiSearchHelper.SearchCostResult, PsiSearchHelper.SERVICE

Constructor Summary

Constructors

Constructor and Description
PsiSearchHelperImpl(Project project)
PsiSearchHelperImpl(PsiManagerEx psiManager) Deprecated. Use PsiSearchHelperImpl(Project)

Method Summary

Modifier and Type	Method and Description
PsiElement []	findCommentsContainingIdentifier(java.lang.String identifier, SearchScope searchScope) Searches the specified scope for comments containing the specified identifier.
PsiFile []	findFilesWithPlainTextWords(java.lang.String word) Returns the list of files which contain the specified word in "plain text" context (for example, plain text files or attribute values in XML files).
SearchScope	getUseScope(PsiElement element) Returns the scope in which references to the specified element are searched.
PsiSearchHelper.SearchCostResult	isCheapEnoughToSearch(java.lang.String name, GlobalSearchScope scope, PsiFile fileToIgnoreOccurrencesIn, ProgressIndicator progress)
boolean	processAllFilesWithWord(java.lang.String word, GlobalSearchScope scope, Processor<? super PsiFile> processor, boolean caseSensitively) Passes all files containing the specified word in code context to the specified processor.
boolean	processAllFilesWithWordInComments(java.lang.String word, GlobalSearchScope scope, Processor<? super PsiFile> processor) Passes all files containing the specified word in comments context to the specified processor.
boolean	processAllFilesWithWordInLiterals(java.lang.String word, GlobalSearchScope scope, Processor<? super PsiFile> processor) Passes all files containing the specified word in string literal context to the specified processor.
boolean	processAllFilesWithWordInText(java.lang.String word, GlobalSearchScope scope, Processor<? super PsiFile> processor, boolean caseSensitively) Passes all files containing the specified word in plain text context to the specified processor.
boolean	processCandidateFilesForText(GlobalSearchScope scope, short searchContext, boolean caseSensitively, java.lang.String text, Processor<? super VirtualFile> processor) Given a text, scope and other search flags, runs the processor on all indexed files that contain all words from the text.
boolean	processCommentsContainingIdentifier(java.lang.String identifier, SearchScope searchScope, Processor<? super PsiElement> processor) Processes the specified scope and hands comments containing the specified identifier over to the processor.
boolean	processElementsWithWord(TextOccurenceProcessor processor, SearchScope searchScope, java.lang.String text, short searchContext, boolean caseSensitive)
boolean	processElementsWithWord(TextOccurenceProcessor processor, SearchScope searchScope, java.lang.String text, short searchContext, boolean caseSensitive, boolean processInjectedPsi)
boolean	processElementsWithWord(TextOccurenceProcessor processor, SearchScope searchScope, java.lang.String text, short searchContext, java.util.EnumSet<PsiSearchHelperImpl.Options> options, java.lang.String containerName)
AsyncFuture<java.lang.Boolean>	processElementsWithWordAsync(TextOccurenceProcessor processor, SearchScope searchScope, java.lang.String text, short searchContext, boolean caseSensitively)
static boolean	processFilesConcurrentlyDespiteWriteActions(Project project, java.util.List<? extends VirtualFile> files, ProgressIndicator progress, java.util.concurrent.atomic.AtomicBoolean stopped, Processor<? super VirtualFile> localProcessor)
boolean	processRequests(SearchRequestCollector collector, Processor<? super PsiReference> processor)
AsyncFuture<java.lang.Boolean>	processRequestsAsync(SearchRequestCollector collector, Processor<? super PsiReference> processor)
boolean	processUsagesInNonJavaFiles(PsiElement originalElement, java.lang.String qName, PsiNonJavaFileReferenceProcessor processor, GlobalSearchScope initialScope) Passes all occurrences of the specified fully qualified class name in plain text context in the use scope of the specified element to the specified processor.
boolean	processUsagesInNonJavaFiles(java.lang.String qName, PsiNonJavaFileReferenceProcessor processor, GlobalSearchScope searchScope) Passes all occurrences of the specified full-qualified class name in plain text context to the specified processor.
static boolean	shouldProcessInjectedPsi(SearchScope scope)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.search.PsiSearchHelper

getInstance

Constructor Detail

PsiSearchHelperImpl

public PsiSearchHelperImpl(Project project)

PsiSearchHelperImpl

@Deprecated
public PsiSearchHelperImpl(PsiManagerEx psiManager)

Deprecated. Use PsiSearchHelperImpl(Project)

Method Detail

getUseScope

public SearchScope getUseScope(PsiElement element)

Description copied from interface: PsiSearchHelper

Returns the scope in which references to the specified element are searched. This scope includes the result of PsiElement.getUseScope() and also the results returned from the registered com.intellij.psi.search.UseScopeEnlarger instances.

Specified by:

getUseScope in interface PsiSearchHelper

Parameters:

element - the element to return the use scope form.

Returns:

the search scope instance.

findCommentsContainingIdentifier

public PsiElement [] findCommentsContainingIdentifier(java.lang.String identifier,
                                                      SearchScope searchScope)

Description copied from interface: PsiSearchHelper

Searches the specified scope for comments containing the specified identifier.

Specified by:

findCommentsContainingIdentifier in interface PsiSearchHelper

Parameters:

identifier - the identifier to search.

searchScope - the scope in which occurrences are searched.

Returns:

the array of found comments.

processCommentsContainingIdentifier

public boolean processCommentsContainingIdentifier(java.lang.String identifier,
                                                   SearchScope searchScope,
                                                   Processor<? super PsiElement> processor)

Description copied from interface: PsiSearchHelper

Processes the specified scope and hands comments containing the specified identifier over to the processor.

Specified by:

processCommentsContainingIdentifier in interface PsiSearchHelper

Parameters:

identifier - the identifier to search.

searchScope - the scope in which occurrences are searched.

Returns:

false if processor returned false, true otherwise

processElementsWithWord

public boolean processElementsWithWord(TextOccurenceProcessor processor,
                                       SearchScope searchScope,
                                       java.lang.String text,
                                       short searchContext,
                                       boolean caseSensitive)

Specified by:

processElementsWithWord in interface PsiSearchHelper

processElementsWithWord

public boolean processElementsWithWord(TextOccurenceProcessor processor,
                                       SearchScope searchScope,
                                       java.lang.String text,
                                       short searchContext,
                                       boolean caseSensitive,
                                       boolean processInjectedPsi)

Specified by:

processElementsWithWord in interface PsiSearchHelper

processElementsWithWordAsync

public AsyncFuture<java.lang.Boolean> processElementsWithWordAsync(TextOccurenceProcessor processor,
                                                                   SearchScope searchScope,
                                                                   java.lang.String text,
                                                                   short searchContext,
                                                                   boolean caseSensitively)

Specified by:

processElementsWithWordAsync in interface PsiSearchHelper

processElementsWithWord

public boolean processElementsWithWord(TextOccurenceProcessor processor,
                                       SearchScope searchScope,
                                       java.lang.String text,
                                       short searchContext,
                                       java.util.EnumSet<PsiSearchHelperImpl.Options> options,
                                       java.lang.String containerName)

shouldProcessInjectedPsi

public static boolean shouldProcessInjectedPsi(SearchScope scope)

processFilesConcurrentlyDespiteWriteActions

public static boolean processFilesConcurrentlyDespiteWriteActions(Project project,
                                                                  java.util.List<? extends VirtualFile> files,
                                                                  ProgressIndicator progress,
                                                                  java.util.concurrent.atomic.AtomicBoolean stopped,
                                                                  Processor<? super VirtualFile> localProcessor)

processCandidateFilesForText

public boolean processCandidateFilesForText(GlobalSearchScope scope,
                                            short searchContext,
                                            boolean caseSensitively,
                                            java.lang.String text,
                                            Processor<? super VirtualFile> processor)

Description copied from interface: PsiSearchHelper

Given a text, scope and other search flags, runs the processor on all indexed files that contain all words from the text. Note that this doesn't mean the files contain the text itself.

Specified by:

processCandidateFilesForText in interface PsiSearchHelper

findFilesWithPlainTextWords

public PsiFile [] findFilesWithPlainTextWords(java.lang.String word)

Description copied from interface: PsiSearchHelper

Returns the list of files which contain the specified word in "plain text" context (for example, plain text files or attribute values in XML files).

Specified by:

findFilesWithPlainTextWords in interface PsiSearchHelper

Parameters:

word - the word to search.

Returns:

the list of files containing the word.

processUsagesInNonJavaFiles

public boolean processUsagesInNonJavaFiles(java.lang.String qName,
                                           PsiNonJavaFileReferenceProcessor processor,
                                           GlobalSearchScope searchScope)

Description copied from interface: PsiSearchHelper

Passes all occurrences of the specified full-qualified class name in plain text context to the specified processor.

Specified by:

processUsagesInNonJavaFiles in interface PsiSearchHelper

Parameters:

qName - the class name to search.

processor - the processor which accepts the references.

searchScope - the scope in which occurrences are searched.

processUsagesInNonJavaFiles

public boolean processUsagesInNonJavaFiles(PsiElement originalElement,
                                           java.lang.String qName,
                                           PsiNonJavaFileReferenceProcessor processor,
                                           GlobalSearchScope initialScope)

Description copied from interface: PsiSearchHelper

Passes all occurrences of the specified fully qualified class name in plain text context in the use scope of the specified element to the specified processor.

Specified by:

processUsagesInNonJavaFiles in interface PsiSearchHelper

Parameters:

originalElement - the element whose use scope is used to restrict the search scope, or null if the search scope is not restricted.

qName - the class name to search.

processor - the processor which accepts the references.

initialScope - the scope in which occurrences are searched.

processAllFilesWithWord

public boolean processAllFilesWithWord(java.lang.String word,
                                       GlobalSearchScope scope,
                                       Processor<? super PsiFile> processor,
                                       boolean caseSensitively)

Description copied from interface: PsiSearchHelper

Passes all files containing the specified word in code context to the specified processor.

Specified by:

processAllFilesWithWord in interface PsiSearchHelper

Parameters:

word - the word to search.

scope - the scope in which occurrences are searched.

processor - the processor which accepts the references.

caseSensitively - if words differing in the case only should not be considered equal

processAllFilesWithWordInText

public boolean processAllFilesWithWordInText(java.lang.String word,
                                             GlobalSearchScope scope,
                                             Processor<? super PsiFile> processor,
                                             boolean caseSensitively)

Description copied from interface: PsiSearchHelper

Passes all files containing the specified word in plain text context to the specified processor.

Specified by:

processAllFilesWithWordInText in interface PsiSearchHelper

Parameters:

word - the word to search.

scope - the scope in which occurrences are searched.

processor - the processor which accepts the references.

caseSensitively - if words differing in the case only should not be considered equal

processAllFilesWithWordInComments

public boolean processAllFilesWithWordInComments(java.lang.String word,
                                                 GlobalSearchScope scope,
                                                 Processor<? super PsiFile> processor)

Description copied from interface: PsiSearchHelper

Passes all files containing the specified word in comments context to the specified processor.

Specified by:

processAllFilesWithWordInComments in interface PsiSearchHelper

Parameters:

word - the word to search.

scope - the scope in which occurrences are searched.

processor - the processor which accepts the references.

processAllFilesWithWordInLiterals

public boolean processAllFilesWithWordInLiterals(java.lang.String word,
                                                 GlobalSearchScope scope,
                                                 Processor<? super PsiFile> processor)

Description copied from interface: PsiSearchHelper

Passes all files containing the specified word in string literal context to the specified processor.

Specified by:

processAllFilesWithWordInLiterals in interface PsiSearchHelper

Parameters:

word - the word to search.

scope - the scope in which occurrences are searched.

processor - the processor which accepts the references.

processRequests

public boolean processRequests(SearchRequestCollector collector,
                               Processor<? super PsiReference> processor)

Specified by:

processRequests in interface PsiSearchHelper

processRequestsAsync

public AsyncFuture<java.lang.Boolean> processRequestsAsync(SearchRequestCollector collector,
                                                           Processor<? super PsiReference> processor)

Specified by:

processRequestsAsync in interface PsiSearchHelper

isCheapEnoughToSearch

public PsiSearchHelper.SearchCostResult isCheapEnoughToSearch(java.lang.String name,
                                                              GlobalSearchScope scope,
                                                              PsiFile fileToIgnoreOccurrencesIn,
                                                              ProgressIndicator progress)

Specified by:

isCheapEnoughToSearch in interface PsiSearchHelper