Package com.intellij.util.indexing

Interface FileBasedIndexInfrastructureExtension

public interface FileBasedIndexInfrastructureExtension

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileBasedIndexInfrastructureExtension.FileIndexingStatusProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileBasedIndexInfrastructureExtension>	EP_NAME

Method Summary

Modifier and Type	Method and Description
<K,V> UpdatableIndex<K,V,FileContent>	combineIndex(FileBasedIndexExtension<K,V> indexExtension, UpdatableIndex<K,V,FileContent> baseIndex) Allows the extension point to replace the original UpdatableIndex for the given with a combined index (base part from FileBasedIndexImpl and customizable one) that that uses the internal state of the extension to supply indexes
FileBasedIndexInfrastructureExtension.FileIndexingStatusProcessor	createFileIndexingStatusProcessor(Project project)
void	onFileBasedIndexVersionChanged(ID<?,?> indexId) Notifies the extension to handle that version of existing file based index version has been changed.
void	onStubIndexVersionChanged(StubIndexKey<?,?> indexId) Notifies the extension to handle that version of existing stub index has been changed.
void	performShutdown() Executed when IntelliJ is shutting down it's indexes (IDE shutdown or plugin load/unload).
void	processProjectEntries(Project project, java.util.Set<OrderEntry> entries, ProgressIndicator indicator) This notification is send from an IDE to let the extension point implementation update it's internal state in order to supply indexes for the given .

Field Detail

EP_NAME

static final ExtensionPointName<FileBasedIndexInfrastructureExtension> EP_NAME

Method Detail

processProjectEntries

void processProjectEntries(Project project,
                           java.util.Set<OrderEntry> entries,
                           ProgressIndicator indicator)

This notification is send from an IDE to let the extension point implementation update it's internal state in order to supply indexes for the given . Called every time when project structure is updated.

createFileIndexingStatusProcessor

FileBasedIndexInfrastructureExtension.FileIndexingStatusProcessor createFileIndexingStatusProcessor(Project project)

combineIndex

<K,V> UpdatableIndex<K,V,FileContent> combineIndex(FileBasedIndexExtension<K,V> indexExtension,
                                                   UpdatableIndex<K,V,FileContent> baseIndex)

Allows the extension point to replace the original UpdatableIndex for the given with a combined index (base part from FileBasedIndexImpl and customizable one) that that uses the internal state of the extension to supply indexes

Returns:

wrapper or null.

onFileBasedIndexVersionChanged

void onFileBasedIndexVersionChanged(ID<?,?> indexId)

Notifies the extension to handle that version of existing file based index version has been changed. Actually FileBasedIndex notifies even if index composite version (extension version + implementation version) is changed FileBasedIndexImpl.getIndexExtensionVersion(FileBasedIndexExtension).

Parameters:

indexId - that version is updated.

onStubIndexVersionChanged

void onStubIndexVersionChanged(StubIndexKey<?,?> indexId)

Notifies the extension to handle that version of existing stub index has been changed.

Parameters:

indexId - that version is updated.

performShutdown

void performShutdown()

Executed when IntelliJ is shutting down it's indexes (IDE shutdown or plugin load/unload). It is the best time for the component to flush it's state to the disk and close all pending connections. TODO: Meanwhile, the implementation should be able to re-open necessary connections if TODO: other methods of the interface are executed after the call to performShutdown()