Package com.intellij.psi.search.searches

Class IndexPatternSearch

java.lang.Object

com.intellij.util.QueryFactory<Result,Parameters>

com.intellij.psi.search.searches.ExtensibleQueryFactory<IndexPatternOccurrence,IndexPatternSearch.SearchParameters>

com.intellij.psi.search.searches.IndexPatternSearch

public abstract class IndexPatternSearch
extends ExtensibleQueryFactory<IndexPatternOccurrence,IndexPatternSearch.SearchParameters>

Allows to search for occurrences of specified regular expressions in the comments of Java source files.

See Also:

IndexPatternProvider, PsiTodoSearchHelper.findFilesWithTodoItems()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexPatternSearch.SearchParameters

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<QueryExecutor<IndexPatternOccurrence,IndexPatternSearch.SearchParameters>>	EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexPatternSearch()

Method Summary

Modifier and Type	Method and Description
static int	getOccurrencesCount(PsiFile file, IndexPattern pattern) Returns the number of occurrences of the specified pattern in the specified file.
static int	getOccurrencesCount(PsiFile file, IndexPatternProvider patternProvider) Returns the number of occurrences of any pattern from the specified provider in the specified file.
protected abstract int	getOccurrencesCountImpl(PsiFile file, IndexPattern pattern)
protected abstract int	getOccurrencesCountImpl(PsiFile file, IndexPatternProvider provider)
static Query<IndexPatternOccurrence>	search(PsiFile file, IndexPattern pattern) Returns a query which can be used to process occurrences of the specified pattern in the specified file.
static Query<IndexPatternOccurrence>	search(PsiFile file, IndexPattern pattern, int startOffset, int endOffset) Returns a query which can be used to process occurrences of the specified pattern in the specified text range.
static Query<IndexPatternOccurrence>	search(PsiFile file, IndexPatternProvider patternProvider) Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified file.
static Query<IndexPatternOccurrence>	search(PsiFile file, IndexPatternProvider patternProvider, boolean multiLineOccurrences) Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified file.
static Query<IndexPatternOccurrence>	search(PsiFile file, IndexPatternProvider patternProvider, int startOffset, int endOffset) Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified text range.

Methods inherited from class com.intellij.psi.search.searches.ExtensibleQueryFactory

getExecutors, registerExecutor, registerExecutor, unregisterExecutor

Methods inherited from class com.intellij.util.QueryFactory

createQuery, createUniqueResultsQuery, createUniqueResultsQuery, createUniqueResultsQuery, hasAnyExecutors

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<QueryExecutor<IndexPatternOccurrence,IndexPatternSearch.SearchParameters>> EP_NAME

Constructor Detail

IndexPatternSearch

protected IndexPatternSearch()

Method Detail

search

public static Query<IndexPatternOccurrence> search(PsiFile file,
                                                   IndexPattern pattern)

Returns a query which can be used to process occurrences of the specified pattern in the specified file. The query is executed by parsing the contents of the file.

Parameters:

file - the file in which occurrences should be searched.

pattern - the pattern to search for.

Returns:

the query instance.

search

public static Query<IndexPatternOccurrence> search(PsiFile file,
                                                   IndexPattern pattern,
                                                   int startOffset,
                                                   int endOffset)

Returns a query which can be used to process occurrences of the specified pattern in the specified text range. The query is executed by parsing the contents of the file.

Parameters:

file - the file in which occurrences should be searched.

pattern - the pattern to search for.

startOffset - the start offset of the range to search.

endOffset - the end offset of the range to search.

Returns:

the query instance.

search

public static Query<IndexPatternOccurrence> search(PsiFile file,
                                                   IndexPatternProvider patternProvider)

Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified file. The query is executed by parsing the contents of the file.

Parameters:

file - the file in which occurrences should be searched.

patternProvider - the provider the patterns from which are searched.

Returns:

the query instance.

search

public static Query<IndexPatternOccurrence> search(PsiFile file,
                                                   IndexPatternProvider patternProvider,
                                                   boolean multiLineOccurrences)

Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified file. The query is executed by parsing the contents of the file.

Parameters:

file - the file in which occurrences should be searched.

patternProvider - the provider the patterns from which are searched.

multiLineOccurrences - whether continuation of occurrences on following lines should be detected (will be returned as IndexPatternOccurrence.getAdditionalTextRanges()

Returns:

the query instance.

search

public static Query<IndexPatternOccurrence> search(PsiFile file,
                                                   IndexPatternProvider patternProvider,
                                                   int startOffset,
                                                   int endOffset)

Returns a query which can be used to process occurrences of any pattern from the specified provider in the specified text range. The query is executed by parsing the contents of the file.

Parameters:

file - the file in which occurrences should be searched.

patternProvider - the provider the patterns from which are searched.

startOffset - the start offset of the range to search.

endOffset - the end offset of the range to search.

Returns:

the query instance.

getOccurrencesCount

public static int getOccurrencesCount(PsiFile file,
                                      IndexPatternProvider patternProvider)

Returns the number of occurrences of any pattern from the specified provider in the specified file. The returned value is taken from the index, and the file is not parsed.

Parameters:

file - the file in which occurrences should be searched.

patternProvider - the provider the patterns from which are searched.

Returns:

the number of pattern occurrences.

getOccurrencesCount

public static int getOccurrencesCount(PsiFile file,
                                      IndexPattern pattern)

Returns the number of occurrences of the specified pattern in the specified file. The returned value is taken from the index, and the file is not parsed.

Parameters:

file - the file in which occurrences should be searched.

pattern - the pattern to search for.

Returns:

the number of pattern occurrences.

getOccurrencesCountImpl

protected abstract int getOccurrencesCountImpl(PsiFile file,
                                               IndexPatternProvider provider)

getOccurrencesCountImpl

protected abstract int getOccurrencesCountImpl(PsiFile file,
                                               IndexPattern pattern)