mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-29 01:37:51 +08:00
63 lines
1.9 KiB
Markdown
63 lines
1.9 KiB
Markdown
[//]: # (title: PSI Cookbook)
|
|
|
|
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
|
|
|
|
This page gives recipes for the most common operations for working with the PSI (Program Structure Interface).
|
|
Unlike [Developing Custom Language Plugins](custom_language_support.md), it talks about working with the PSI of existing languages (such as Java).
|
|
|
|
> Please see also [Working with PSI efficiently](performance.md#working-with-psi-efficiently).
|
|
>
|
|
{type="tip"}
|
|
|
|
### How do I find a file if I know its name but don't know the path?
|
|
|
|
`FilenameIndex.getFilesByName()`
|
|
|
|
### How do I find where a particular PSI element is used?
|
|
|
|
`ReferencesSearch.search()`
|
|
|
|
### How do I rename a PSI element?
|
|
|
|
`RefactoringFactory.createRename()`
|
|
|
|
### How can I cause the PSI for a virtual file to be rebuilt?
|
|
|
|
`FileContentUtil.reparseFiles()`
|
|
|
|
## Java Specific
|
|
|
|
> If your plugin depends on Java functionality and targets 2019.2 or later, please make sure to follow the steps from this [blog post](https://blog.jetbrains.com/platform/2019/06/java-functionality-extracted-as-a-plugin/).
|
|
>
|
|
{type="note"}
|
|
|
|
### How do I find all inheritors of a class?
|
|
|
|
`ClassInheritorsSearch.search()`
|
|
|
|
### How do I find a class by qualified name?
|
|
|
|
`JavaPsiFacade.findClass()`
|
|
|
|
### How do I find a class by short name?
|
|
|
|
`PsiShortNamesCache.getInstance().getClassesByName()`
|
|
|
|
### How do I find a superclass of a Java class?
|
|
|
|
`PsiClass.getSuperClass()`
|
|
|
|
### How do I get a reference to the containing package of a Java class?
|
|
|
|
```java
|
|
PsiJavaFile javaFile = (PsiJavaFile) psiClass.getContainingFile();
|
|
PsiPackage pkg = JavaPsiFacade.getInstance(project).findPackage(javaFile.getPackageName());
|
|
```
|
|
|
|
or
|
|
|
|
`com.intellij.psi.util.PsiUtil.getPackageName()`
|
|
|
|
### How do I find the methods overriding a specific method?
|
|
|
|
`OverridingMethodsSearch.search()` |