PSI Cookbook
This page gives recipes for the most common operations for working with the PSI (Program Structure Interface).
Unlike Developing Custom Language Plugins, it is about working with the PSI of existing languages (such as Java).
General
How do I find a file if I know its name but don't know the path?
How do I find where a particular PSI element is used?
How do I rename a PSI element?
How can I cause the PSI for a virtual file to be rebuilt?
Java Specific
How do I find all inheritors of a class?
How do I find a class by qualified name?
How do I find a class by short name?
How do I find a superclass of a Java class?
How do I get a reference to the containing package of a Java class?
PsiJavaFile javaFile = (PsiJavaFile) psiClass.getContainingFile();
PsiPackage psiPackage = JavaPsiFacade.getInstance(project)
.findPackage(javaFile.getPackageName());
or
How do I find the methods overriding a specific method?
How do I check the presence of a JVM library?
Use dedicated (and heavily cached) methods from JavaLibraryUtil:
hasLibraryClass()to check presence via known library class FQNhasLibraryJar()using Maven coordinates (for example,io.micronaut:micronaut-core).
Last modified: 13 June 2024