Package com.intellij.psi.search

Interface PsiTodoSearchHelper

All Known Implementing Classes:

PsiTodoSearchHelperImpl

public interface PsiTodoSearchHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PsiTodoSearchHelper.SERVICE

Method Summary

Modifier and Type	Method and Description
PsiFile []	findFilesWithTodoItems() Returns the list of all files in the project which have to do items.
TodoItem []	findTodoItems(PsiFile file) Searches the specified file for to do items.
TodoItem []	findTodoItems(PsiFile file, int startOffset, int endOffset) Searches the specified range of text in the specified file for to do items.
TodoItem []	findTodoItemsLight(PsiFile file)
TodoItem []	findTodoItemsLight(PsiFile file, int startOffset, int endOffset)
int	getTodoItemsCount(PsiFile file) Returns the number of to do items in the specified file.
int	getTodoItemsCount(PsiFile file, TodoPattern pattern) Returns the number of to do items matching the specified pattern in the specified file.

Method Detail

findFilesWithTodoItems

PsiFile [] findFilesWithTodoItems()

Returns the list of all files in the project which have to do items.

Returns:

the list of files with to do items.

findTodoItems

TodoItem [] findTodoItems(PsiFile file)

Searches the specified file for to do items.

Parameters:

file - the file to search for to do items.

Returns:

the array of found items.

findTodoItems

TodoItem [] findTodoItems(PsiFile file,
                          int startOffset,
                          int endOffset)

Searches the specified range of text in the specified file for to do items.

Parameters:

file - the file to search for to do items.

startOffset - the start offset of the text range to search to do items in.

endOffset - the end offset of the text range to search to do items in.

Returns:

the array of found items.

findTodoItemsLight

TodoItem [] findTodoItemsLight(PsiFile file)

findTodoItemsLight

TodoItem [] findTodoItemsLight(PsiFile file,
                               int startOffset,
                               int endOffset)

getTodoItemsCount

int getTodoItemsCount(PsiFile file)

Returns the number of to do items in the specified file.

Parameters:

file - the file to return the to do count for.

Returns:

the count of to do items in the file.

getTodoItemsCount

int getTodoItemsCount(PsiFile file,
                      TodoPattern pattern)

Returns the number of to do items matching the specified pattern in the specified file.

Parameters:

file - the file to return the to do count for.

pattern - the pattern of to do items to find.

Returns:

the count of to do items in the file.