Package com.intellij.util.indexing

Class FileBasedIndexExtension<K,V>

java.lang.Object

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

com.intellij.util.indexing.FileBasedIndexExtension<K,V>

Direct Known Subclasses:

DuplicatesIndex, FileIncludeIndex, IdIndex, JavaBinaryPlusExpressionIndex, JavaFunctionalExpressionIndex, JavaFxCustomComponentsIndex, JavaFxIdsIndex, JsonSchemaFileValuesIndex, RefQueueIndex, ScalarIndexExtension, SingleEntryFileBasedIndexExtension, TodoIndex, XmlIndex, XmlPropertiesIndex, XsltSymbolIndex, YAMLKeysIndex

public abstract class FileBasedIndexExtension<K,V>
extends IndexExtension<K,V,FileContent>

SDK Docs

V class MUST have equals / hashcode properly defined!!!

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileBasedIndexExtension<?,?>>	EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
FileBasedIndexExtension()

Method Summary

Modifier and Type	Method and Description
abstract boolean	dependsOnFileContent()
int	getCacheSize()
java.util.Collection<FileType>	getFileTypesWithSizeLimitNotApplicable() For most indices the method should return an empty collection.
abstract FileBasedIndex.InputFilter	getInputFilter()
abstract ID<K,V>	getName()
boolean	hasSnapshotMapping()
boolean	indexDirectories()
boolean	keyIsUniqueForIndexedFile()
boolean	needsForwardIndexWhenSharing() Whether this index needs the forward mapping to be shared along with inverted index.
boolean	traceKeyHashToVirtualFileMapping()

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

getIndexer, getKeyDescriptor, getValueExternalizer, getVersion

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT_NAME

public static final ExtensionPointName<FileBasedIndexExtension<?,?>> EXTENSION_POINT_NAME

Constructor Detail

FileBasedIndexExtension

public FileBasedIndexExtension()

Method Detail

getName

public abstract ID<K,V> getName()

Specified by:

getName in class IndexExtension<K,V,FileContent>

getInputFilter

public abstract FileBasedIndex.InputFilter getInputFilter()

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.

dependsOnFileContent

public abstract boolean dependsOnFileContent()

indexDirectories

public boolean indexDirectories()

getCacheSize

public int getCacheSize()

See Also:

DEFAULT_CACHE_SIZE

getFileTypesWithSizeLimitNotApplicable

public java.util.Collection<FileType> getFileTypesWithSizeLimitNotApplicable()

For most indices the method should return an empty collection.

Returns:

collection of file types to which file size limit will not be applied when indexing. This is the way to allow indexing of files whose limit exceeds PersistentFSConstants.getMaxIntellisenseFileSize().

Use carefully, because indexing large files may influence index update speed dramatically.

keyIsUniqueForIndexedFile

public boolean keyIsUniqueForIndexedFile()

traceKeyHashToVirtualFileMapping

public boolean traceKeyHashToVirtualFileMapping()

hasSnapshotMapping

public boolean hasSnapshotMapping()

needsForwardIndexWhenSharing

public boolean needsForwardIndexWhenSharing()

Whether this index needs the forward mapping to be shared along with inverted index. If this method returns false, it is an error to call FileBasedIndex.getFileData(ID, VirtualFile, Project) for this index.