Package com.intellij.psi.impl.search

Class PsiTodoSearchHelperImpl

java.lang.Object

com.intellij.psi.impl.search.PsiTodoSearchHelperImpl

All Implemented Interfaces:

PsiTodoSearchHelper

public class PsiTodoSearchHelperImpl
extends java.lang.Object
implements PsiTodoSearchHelper

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.search.PsiTodoSearchHelper

PsiTodoSearchHelper.SERVICE

Constructor Summary

Constructors

Constructor and Description
PsiTodoSearchHelperImpl(Project project)
PsiTodoSearchHelperImpl(PsiManagerEx psiManager) Deprecated. Use PsiTodoSearchHelperImpl(Project)

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.
boolean	shouldHighlightInEditor(PsiFile file) Returns if td items should be highlighted in editor

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiTodoSearchHelperImpl

public PsiTodoSearchHelperImpl(Project project)

PsiTodoSearchHelperImpl

@Deprecated
public PsiTodoSearchHelperImpl(PsiManagerEx psiManager)

Deprecated. Use PsiTodoSearchHelperImpl(Project)

Method Detail

findFilesWithTodoItems

public PsiFile [] findFilesWithTodoItems()

Description copied from interface: PsiTodoSearchHelper

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

Specified by:

findFilesWithTodoItems in interface PsiTodoSearchHelper

Returns:

the list of files with to do items.

findTodoItems

public TodoItem [] findTodoItems(PsiFile file)

Description copied from interface: PsiTodoSearchHelper

Searches the specified file for to do items.

Specified by:

findTodoItems in interface PsiTodoSearchHelper

Parameters:

file - the file to search for to do items.

Returns:

the array of found items.

findTodoItems

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

Description copied from interface: PsiTodoSearchHelper

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

Specified by:

findTodoItems in interface PsiTodoSearchHelper

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

public TodoItem [] findTodoItemsLight(PsiFile file)

Specified by:

findTodoItemsLight in interface PsiTodoSearchHelper

findTodoItemsLight

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

Specified by:

findTodoItemsLight in interface PsiTodoSearchHelper

getTodoItemsCount

public int getTodoItemsCount(PsiFile file)

Description copied from interface: PsiTodoSearchHelper

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

Specified by:

getTodoItemsCount in interface PsiTodoSearchHelper

Parameters:

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

Returns:

the count of to do items in the file.

getTodoItemsCount

public int getTodoItemsCount(PsiFile file,
                             TodoPattern pattern)

Description copied from interface: PsiTodoSearchHelper

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

Specified by:

getTodoItemsCount in interface PsiTodoSearchHelper

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.

shouldHighlightInEditor

public boolean shouldHighlightInEditor(PsiFile file)

Returns if td items should be highlighted in editor

Parameters:

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

Returns:

if td items should be highlighted in editor. True by default