hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

stub_indexes.md: note IStubElementType#isAlwaysLeaf()

Browse Source
This commit is contained in:
Yann Cébron 2023-09-13 09:34:28 +02:00
parent 8f192b1bbb
commit 32790b35a9
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
topics/basics/indexing_and_psi_stubs/stub_indexes.md
View File

@ -56,6 +56,7 @@ For each element type that needs to be stored in the stub tree, perform the foll
Implement the `createPsi()` and `createStub()` methods for creating PSI from a stub and vice versa.
Implement the `serialize()` and `deserialize()` methods for storing the data in a binary stream.
Override `getExternalId()` according to common used `externalIdPrefix` for the language.
For always-leaf stub nodes return `true` from `isAlwaysLeaf()` (2023.3).
6. Use the class implementing `IStubElementType` as the element type constant when parsing ([example](%gh-ic%/plugins/properties/properties-psi-impl/src/com/intellij/lang/properties/parsing/PropertiesElementTypes.java)).
7. Make sure all methods in the PSI element interface access the stub data rather than the PSI tree when appropriate ([example: `Property.getKey()` implementation](%gh-ic%/plugins/properties/properties-psi-impl/src/com/intellij/lang/properties/psi/impl/PropertyImpl.java)).