Package com.intellij.psi.search

Class RequestResultProcessor.BulkResultProcessor

java.lang.Object

com.intellij.psi.search.RequestResultProcessor

com.intellij.psi.search.RequestResultProcessor.BulkResultProcessor

Enclosing class:

RequestResultProcessor

public abstract static class RequestResultProcessor.BulkResultProcessor
extends RequestResultProcessor

A variant of RequestResultProcessor that processes all text occurrences at once, e.g. for performance purposes.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.search.RequestResultProcessor

RequestResultProcessor.BulkResultProcessor

Constructor Summary

Constructors

Constructor and Description
BulkResultProcessor()
BulkResultProcessor(java.lang.Object... equality)

Method Summary

Modifier and Type	Method and Description
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.
abstract boolean	processTextOccurrences(PsiElement scope, int[] offsetsInScope, Processor<? super PsiReference> consumer) Invoked for every element of the search scope (e.g.

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkResultProcessor

public BulkResultProcessor()

BulkResultProcessor

public BulkResultProcessor(java.lang.Object... equality)

Method Detail

processTextOccurrence

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

Description copied from class: RequestResultProcessor

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.

Specified by:

processTextOccurrence in class RequestResultProcessor

Returns:

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

processTextOccurrences

public abstract boolean processTextOccurrences(PsiElement scope,
                                               int[] offsetsInScope,
                                               Processor<? super PsiReference> consumer)

Invoked for every element of the search scope (e.g. file) with the array of all offsets of search string occurrences in this scope. Offsets are relative to scope start offset. The implementation is supposed to search for references inside the given element at the given offsets, and feed them to consumer.

Returns:

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