Package com.intellij.psi.tree

Class IStubFileElementType<T extends PsiFileStub>

java.lang.Object

com.intellij.psi.tree.IElementType

com.intellij.psi.tree.ILazyParseableElementType

com.intellij.psi.tree.IFileElementType

com.intellij.psi.tree.StubFileElementType<T>

com.intellij.psi.tree.IStubFileElementType<T>

All Implemented Interfaces:

ObjectStubSerializer<T,StubElement>, StubSerializer<T>, ILazyParseableElementTypeBase

Direct Known Subclasses:

GrStubFileElementType, HtmlFileElementType, ILightStubFileElementType, PyFileElementType

public class IStubFileElementType<T extends PsiFileStub>
extends StubFileElementType<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.tree.IElementType

IElementType.Predicate

Field Summary

Fields inherited from class com.intellij.psi.tree.StubFileElementType

DEFAULT_EXTERNAL_ID

Fields inherited from class com.intellij.psi.tree.ILazyParseableElementType

LANGUAGE_KEY

Fields inherited from class com.intellij.psi.tree.IElementType

ARRAY_FACTORY, EMPTY_ARRAY, FIRST_TOKEN_INDEX, TRUE

Constructor Summary

Constructors

Constructor and Description
IStubFileElementType(Language language)
IStubFileElementType(java.lang.String debugName, Language language)

Method Summary

Modifier and Type	Method and Description
T	deserialize(StubInputStream dataStream, StubElement parentStub)
StubBuilder	getBuilder()
java.lang.String	getExternalId()
int	getStubVersion() Stub structure version.
static int	getTemplateStubVersion()
void	indexStub(PsiFileStub stub, IndexSink sink)
void	serialize(T stub, StubOutputStream dataStream)
boolean	shouldBuildStubFor(VirtualFile file)

Methods inherited from class com.intellij.psi.tree.IFileElementType

parseContents

Methods inherited from class com.intellij.psi.tree.ILazyParseableElementType

createNode, doParseContents, getLanguageForParser, parseLight, reuseCollapsedTokens

Methods inherited from class com.intellij.psi.tree.IElementType

enumerate, find, getIndex, getLanguage, hashCode, isLeftBound, toString, unregisterElementTypes, unregisterElementTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

IStubFileElementType

public IStubFileElementType(Language language)

IStubFileElementType

public IStubFileElementType(java.lang.String debugName,
                            Language language)

Method Detail

getStubVersion

public int getStubVersion()

Stub structure version. Should be incremented each time when stub tree changes (e.g. elements added/removed, element serialization/deserialization changes). Make sure to invoke super method for TemplateLanguage to prevent stub serialization problems due to data language stub changes

Returns:

stub version

getBuilder

public StubBuilder getBuilder()

getExternalId

public java.lang.String getExternalId()

serialize

public void serialize(T stub,
                      StubOutputStream dataStream)
               throws java.io.IOException

Throws:

java.io.IOException

deserialize

public T deserialize(StubInputStream dataStream,
                     StubElement parentStub)
              throws java.io.IOException

Throws:

java.io.IOException

indexStub

public void indexStub(PsiFileStub stub,
                      IndexSink sink)

shouldBuildStubFor

public boolean shouldBuildStubFor(VirtualFile file)

getTemplateStubVersion

public static int getTemplateStubVersion()