Package com.intellij.psi.impl.cache.impl.todo

Class TodoIndex

java.lang.Object

com.intellij.util.indexing.IndexExtension<K,V,FileContent>

com.intellij.util.indexing.FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>

com.intellij.psi.impl.cache.impl.todo.TodoIndex

public final class TodoIndex
extends FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>

Field Summary

Fields

Modifier and Type	Field and Description
protected FileBasedIndex.InputFilter	myInputFilter
static ID<TodoIndexEntry,java.lang.Integer>	NAME

Fields inherited from class com.intellij.util.indexing.FileBasedIndexExtension

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
TodoIndex()

Method Summary

Modifier and Type	Method and Description
boolean	dependsOnFileContent()
DataIndexer<TodoIndexEntry,java.lang.Integer,FileContent>	getIndexer()
FileBasedIndex.InputFilter	getInputFilter()
KeyDescriptor<TodoIndexEntry>	getKeyDescriptor()
ID<TodoIndexEntry,java.lang.Integer>	getName()
DataExternalizer<java.lang.Integer>	getValueExternalizer()
int	getVersion()
boolean	hasSnapshotMapping()

Methods inherited from class com.intellij.util.indexing.FileBasedIndexExtension

getCacheSize, getFileTypesWithSizeLimitNotApplicable, indexDirectories, keyIsUniqueForIndexedFile, needsForwardIndexWhenSharing, traceKeyHashToVirtualFileMapping

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ID<TodoIndexEntry,java.lang.Integer> NAME

myInputFilter

protected final FileBasedIndex.InputFilter myInputFilter

Constructor Detail

TodoIndex

public TodoIndex()

Method Detail

getVersion

public int getVersion()

Specified by:

getVersion in class IndexExtension<TodoIndexEntry,java.lang.Integer,FileContent>

dependsOnFileContent

public boolean dependsOnFileContent()

Specified by:

dependsOnFileContent in class FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>

getName

public ID<TodoIndexEntry,java.lang.Integer> getName()

Specified by:

getName in class FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>

getIndexer

public DataIndexer<TodoIndexEntry,java.lang.Integer,FileContent> getIndexer()

Specified by:

getIndexer in class IndexExtension<TodoIndexEntry,java.lang.Integer,FileContent>

getKeyDescriptor

public KeyDescriptor<TodoIndexEntry> getKeyDescriptor()

Specified by:

getKeyDescriptor in class IndexExtension<TodoIndexEntry,java.lang.Integer,FileContent>

getValueExternalizer

public DataExternalizer<java.lang.Integer> getValueExternalizer()

Specified by:

getValueExternalizer in class IndexExtension<TodoIndexEntry,java.lang.Integer,FileContent>

getInputFilter

public FileBasedIndex.InputFilter getInputFilter()

Specified by:

getInputFilter in class FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>

Returns:

filter for file are supposed being indexed by the IndexExtension.getIndexer(). Usually DefaultFileTypeSpecificInputFilter can be used here to index only files with given file-type. Note that check only file's extension is usually error-prone way and prefer to check VirtualFile.getFileType(): for example user can enforce language file as plain text one.

hasSnapshotMapping

public boolean hasSnapshotMapping()

Overrides:

hasSnapshotMapping in class FileBasedIndexExtension<TodoIndexEntry,java.lang.Integer>