Package com.intellij.psi.search

Class RequestResultProcessor

java.lang.Object

com.intellij.psi.search.RequestResultProcessor

Direct Known Subclasses:

MethodTextOccurrenceProcessor, RequestResultProcessor.BulkResultProcessor, SingleTargetRequestResultProcessor

public abstract class RequestResultProcessor
extends java.lang.Object

An occurrence processor for Find Usages functionality. A typical scenario involves invoking ReferencesSearch.SearchParameters#getOptimizer() and passing this processor together with search string and some other parameters to SearchRequestCollector.searchWord(String, SearchScope, short, boolean, PsiElement, RequestResultProcessor).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestResultProcessor.BulkResultProcessor A variant of RequestResultProcessor that processes all text occurrences at once, e.g.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestResultProcessor(java.lang.Object... equality)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
abstract boolean	processTextOccurrence(PsiElement element, int offsetInElement, Processor<? super PsiReference> consumer) For every occurrence of the search string in the search scope, the infrastructure invokes this method for every PSI element having that occurrence inside, from leaf elements up the tree until file element.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestResultProcessor

protected RequestResultProcessor(java.lang.Object... equality)

Parameters:

equality - this processor's equals/hashCode will delegate to this object

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

processTextOccurrence

public abstract boolean processTextOccurrence(PsiElement element,
                                              int offsetInElement,
                                              Processor<? super PsiReference> consumer)

For every occurrence of the search string in the search scope, the infrastructure invokes this method for every PSI element having that occurrence inside, from leaf elements up the tree until file element. The implementation is supposed to search for references inside the given element at the given offset, and feed them to consumer.

If you wish to process all offsets in the scope (e.g. file) at once, extend RequestResultProcessor.BulkResultProcessor.

Returns:

whether the consumer has returned false for any of the references (and thus stopped searching), false otherwise.