Package com.intellij.psi.stubs

Class StubUpdatingIndex

java.lang.Object

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

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

com.intellij.util.indexing.SingleEntryFileBasedIndexExtension<SerializedStubTree>

com.intellij.psi.stubs.StubUpdatingIndex

All Implemented Interfaces:

CustomImplementationFileBasedIndexExtension<java.lang.Integer,SerializedStubTree>

public class StubUpdatingIndex
extends SingleEntryFileBasedIndexExtension<SerializedStubTree>
implements CustomImplementationFileBasedIndexExtension<java.lang.Integer,SerializedStubTree>

Field Summary

Fields

Modifier and Type	Field and Description
static ID<java.lang.Integer,SerializedStubTree>	INDEX_ID

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

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
StubUpdatingIndex()
StubUpdatingIndex(StubForwardIndexExternalizer<?> stubIndexesExternalizer, SerializationManagerEx serializationManager)

Method Summary

Modifier and Type	Method and Description
static boolean	canHaveStub(VirtualFile file)
UpdatableIndex<java.lang.Integer,SerializedStubTree,FileContent>	createIndexImplementation(FileBasedIndexExtension<java.lang.Integer,SerializedStubTree> extension, IndexStorage<java.lang.Integer,SerializedStubTree> storage)
SingleEntryIndexer<SerializedStubTree>	getIndexer()
FileBasedIndex.InputFilter	getInputFilter()
ID<java.lang.Integer,SerializedStubTree>	getName()
DataExternalizer<SerializedStubTree>	getValueExternalizer()
int	getVersion()

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

dependsOnFileContent, getCacheSize, getFileKey, getKeyDescriptor, keyIsUniqueForIndexedFile

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

getFileTypesWithSizeLimitNotApplicable, hasSnapshotMapping, indexDirectories, needsForwardIndexWhenSharing, traceKeyHashToVirtualFileMapping

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_ID

public static final ID<java.lang.Integer,SerializedStubTree> INDEX_ID

Constructor Detail

StubUpdatingIndex

public StubUpdatingIndex()

StubUpdatingIndex

public StubUpdatingIndex(StubForwardIndexExternalizer<?> stubIndexesExternalizer,
                         SerializationManagerEx serializationManager)

Method Detail

canHaveStub

public static boolean canHaveStub(VirtualFile file)

getName

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

Specified by:

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

getIndexer

public SingleEntryIndexer<SerializedStubTree> getIndexer()

Specified by:

getIndexer in class SingleEntryFileBasedIndexExtension<SerializedStubTree>

getValueExternalizer

public DataExternalizer<SerializedStubTree> getValueExternalizer()

Specified by:

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

getInputFilter

public FileBasedIndex.InputFilter getInputFilter()

Specified by:

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

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.

getVersion

public int getVersion()

Specified by:

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

createIndexImplementation

public UpdatableIndex<java.lang.Integer,SerializedStubTree,FileContent> createIndexImplementation(FileBasedIndexExtension<java.lang.Integer,SerializedStubTree> extension,
                                                                                                  IndexStorage<java.lang.Integer,SerializedStubTree> storage)
                                                                                           throws StorageException,
                                                                                                  java.io.IOException

Specified by:

createIndexImplementation in interface CustomImplementationFileBasedIndexExtension<java.lang.Integer,SerializedStubTree>

Throws:

StorageException

java.io.IOException