Package com.intellij.openapi.application

Class QueryExecutorBase<Result,Params>

java.lang.Object

com.intellij.openapi.application.QueryExecutorBase<Result,Params>

All Implemented Interfaces:

QueryExecutor<Result,Params>

Direct Known Subclasses:

AccessorReferencesSearcher, CachesBasedRefSearcher, ClassesWithAnnotatedMembersSearcher, ConstructorReferencesSearcher, ConstructorReferencesSearcher, GrAliasedImportedElementSearcher, GrLiteralMethodSearcher, GroovyConstructorUsagesSearcher, GroovyReflectedMethodReferenceSearcher, GroovyTraitFieldSearcher, ImplicitToStringSearcher, IndexPatternSearcher, JavaClassInheritorsSearcher, JavaFunctionalExpressionSearcher, JavaRecordComponentSearcher, MethodLateBoundReferencesSearcher, MethodSuperSearcher, MethodUsagesSearcher, NonPhysicalReferenceSearcher, PropertiesInheritorsSearcher, PyClassReferenceSearchExecutor, PyInitReferenceSearchExecutor, PyKeywordArgumentSearchExecutor, PyStringReferenceSearch, SimpleAccessorReferenceSearcher, SPIReferencesSearcher, VariableInIncompleteCodeSearcher

public abstract class QueryExecutorBase<Result,Params>
extends java.lang.Object
implements QueryExecutor<Result,Params>

An adapter for QueryExecutor interface which makes it easier to write implementations. It provides a possibility to automatically wrap the implementation code into a read action. During indexing, query executors that don't implement DumbAware (but need to be run in a read action), are delayed until indexing is complete, given that search parameters implement DumbAwareSearchParameters.

Besides, processQuery(Object, Processor) doesn't require to return a boolean value and thus it's harder to stop the whole search by accidentally returning false.

See Also:

Application.runReadAction(Computable), DumbService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryExecutorBase() Construct an instance that executes processQuery(Object, Processor) as is, without wrapping into a read action.
protected	QueryExecutorBase(boolean requireReadAction)

Method Summary

Modifier and Type	Method and Description
boolean	execute(Params queryParameters, Processor<? super Result> consumer) Find some results according to queryParameters and feed them to consumer.
abstract void	processQuery(Params queryParameters, Processor<? super Result> consumer) Find some results according to queryParameters and feed them to consumer.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryExecutorBase

protected QueryExecutorBase(boolean requireReadAction)

Parameters:

requireReadAction - whether processQuery(Object, Processor) should be wrapped into a read action.

QueryExecutorBase

protected QueryExecutorBase()

Construct an instance that executes processQuery(Object, Processor) as is, without wrapping into a read action.

Method Detail

execute

public final boolean execute(Params queryParameters,
                             Processor<? super Result> consumer)

Description copied from interface: QueryExecutor

Find some results according to queryParameters and feed them to consumer. If consumer returns false, stop.

Specified by:

execute in interface QueryExecutor<Result,Params>

Returns:

false if the searching should be stopped immediately. This should happen only when consumer has returned false.

processQuery

public abstract void processQuery(Params queryParameters,
                                  Processor<? super Result> consumer)

Find some results according to queryParameters and feed them to consumer. If consumer returns false, stop.