Package com.intellij.psi.stubs

Class StubElementTypeHolderEP

java.lang.Object

com.intellij.openapi.extensions.AbstractExtensionPointBean

com.intellij.psi.stubs.StubElementTypeHolderEP

All Implemented Interfaces:

PluginAware

public class StubElementTypeHolderEP
extends AbstractExtensionPointBean

An extension that enumerates classes defining stub element types for all languages. Index infrastructure needs their names to work correctly, so they're loaded via this extension when necessary.

To speed up IDE loading, it's recommended that this extension is used for interfaces containing only IStubElementType (or ObjectStubSerializer) constants, and all other language's element types are kept in a separate interface that can be loaded later.

Also consider specifying externalIdPrefix for further speedup.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<StubElementTypeHolderEP>	EP_NAME
java.lang.String	externalIdPrefix Allows to avoid class initialization by declaring that the stub element type holder obeys the following contract: It's an interface All stub element types to load are declared as fields in the interface itself, not in super-interfaces For all IStubElementType fields, their ObjectStubSerializer.getExternalId(): doesn't depend on class fields, so that it can be called during IStubElementType construction effectively returns "somePrefix" + debugName debugName is equal to the field name "somePrefix" is the value of "externalIdPrefix" attribute For all other fields, if any, the same prefix+debugName concatenation doesn't produce an external id used by any other stub element type
java.lang.String	holderClass

Fields inherited from class com.intellij.openapi.extensions.AbstractExtensionPointBean

myPluginDescriptor

Constructor Summary

Constructors

Constructor and Description
StubElementTypeHolderEP()

Method Summary

Modifier and Type	Method and Description
void	initialize() Deprecated. please don't use this extension to ensure something is initialized as a side effect of stub element type loading, create your own narrow-scoped extension instead
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.extensions.AbstractExtensionPointBean

findClass, findClass, findClassNoExceptions, findExtensionClass, getLoaderForClass, getPluginDescriptor, getPluginId, instantiate, instantiate, instantiate, instantiateClass, setPluginDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<StubElementTypeHolderEP> EP_NAME

holderClass

public java.lang.String holderClass

externalIdPrefix

public java.lang.String externalIdPrefix

Allows to avoid class initialization by declaring that the stub element type holder obeys the following contract:

• It's an interface
• All stub element types to load are declared as fields in the interface itself, not in super-interfaces
• For all IStubElementType fields, their ObjectStubSerializer.getExternalId():
  • doesn't depend on class fields, so that it can be called during IStubElementType construction
  • effectively returns "somePrefix" + debugName
  • debugName is equal to the field name
  • "somePrefix" is the value of "externalIdPrefix" attribute
• For all other fields, if any, the same prefix+debugName concatenation doesn't produce an external id used by any other stub element type

Constructor Detail

StubElementTypeHolderEP

public StubElementTypeHolderEP()

Method Detail

initialize

@Deprecated
public void initialize()

Deprecated. please don't use this extension to ensure something is initialized as a side effect of stub element type loading, create your own narrow-scoped extension instead

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object