Package com.intellij.util

Class AbstractQuery<Result>

java.lang.Object

com.intellij.util.AbstractQuery<Result>

All Implemented Interfaces:

Query<Result>, java.lang.Iterable<Result>

Direct Known Subclasses:

ExecutorsQuery, FilteredQuery, InstanceofQuery, SearchRequestQuery, UniqueResultsQuery

public abstract class AbstractQuery<Result>
extends java.lang.Object
implements Query<Result>

Constructor Summary

Constructors

Constructor and Description
AbstractQuery()

Method Summary

Modifier and Type	Method and Description
Query<Result>	allowParallelProcessing()
protected static <T> boolean	delegateProcessResults(Query<T> query, Processor<? super T> consumer) Should be called only from processResults(com.intellij.util.Processor<? super Result>) implementations to delegate to another query
java.util.Collection<Result>	findAll() Get all of the results in the Collection
Result	findFirst() Get the first result or null if no results have been found.
boolean	forEach(Processor<? super Result> consumer) Process search results one-by-one.
AsyncFuture<java.lang.Boolean>	forEachAsync(Processor<? super Result> consumer)
java.util.Iterator<Result>	iterator()
protected abstract boolean	processResults(Processor<? super Result> consumer) Assumes consumer being capable of processing results in parallel
Result []	toArray(Result [] a)
static <T> Query<T>	wrapInReadAction(Query<? extends T> query)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.util.Query

allMatch, anyMatch, filtering, flatMapping, mapping

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractQuery

public AbstractQuery()

Method Detail

findAll

public java.util.Collection<Result> findAll()

Description copied from interface: Query

Get all of the results in the Collection

Specified by:

findAll in interface Query<Result>

Returns:

results in a collection or empty collection if no results found.

iterator

public java.util.Iterator<Result> iterator()

Specified by:

iterator in interface java.lang.Iterable<Result>

findFirst

public Result findFirst()

Description copied from interface: Query

Get the first result or null if no results have been found.

Specified by:

findFirst in interface Query<Result>

Returns:

first result of the search or null if no results.

toArray

public Result [] toArray(Result [] a)

Specified by:

toArray in interface Query<Result>

allowParallelProcessing

public Query<Result> allowParallelProcessing()

Specified by:

allowParallelProcessing in interface Query<Result>

Returns:

an equivalent query whose Query.forEach(com.intellij.util.Processor<? super Result>) accepts non-thread-safe consumers, so it may call the consumer in parallel.

forEach

public boolean forEach(Processor<? super Result> consumer)

Description copied from interface: Query

Process search results one-by-one. All the results will be subsequently fed to a consumer passed. The consumer might be called on different threads, but by default these calls are mutually exclusive, so no additional synchronization inside consumer is necessary. If you need to process results in parallel, run forEach() on the result of Query.allowParallelProcessing().

Specified by:

forEach in interface Query<Result>

Parameters:

consumer - - a processor search results should be fed to.

Returns:

true if the search was completed normally, false if the occurrence processing was cancelled by the processor.

forEachAsync

public AsyncFuture<java.lang.Boolean> forEachAsync(Processor<? super Result> consumer)

Specified by:

forEachAsync in interface Query<Result>

processResults

protected abstract boolean processResults(Processor<? super Result> consumer)

Assumes consumer being capable of processing results in parallel

delegateProcessResults

protected static <T> boolean delegateProcessResults(Query<T> query,
                                                    Processor<? super T> consumer)

Should be called only from processResults(com.intellij.util.Processor<? super Result>) implementations to delegate to another query

wrapInReadAction

public static <T> Query<T> wrapInReadAction(Query<? extends T> query)