Internal API Migration
This page lists commonly used API annotated with @ApiStatus.Internal
or @IntellijInternalApi
which indicates it is private API and must not be used outside of IntelliJ Platform itself:
Such violations are reported from Plugin Verifier and are highlighted in the IDE using a dedicated inspection.
Each entry is mapped to its corresponding Replacement, pointing to the recommended API.
IntelliJ Platform
Internal API | Replacement |
---|---|
| |
| |
| Use |
| Use |
| Use extension points and services |
| |
| Use static methods in |
| Override/use |
| Use methods exposed in |
| Use |
| |
| |
| |
| |
| Use |
| Use |
| |
| Cast to |
| Use own logger, see Logging |
| Use |
| Use |
| Use |
| |
| |
| |
| Use |
Plugins
Database Plugin
Internal API | Replacement |
---|---|
| For connection config use |
Exceptions
The API listed in this table is currently (or was previously) marked with @ApiStatus.Internal
, but its status has changed in the meantime (or will change). Therefore, any reported violations can be disregarded.
Internal API | Note |
---|---|
Made public in 2023.3 | |
Made public in 2021.3 | |
Made public in 2023.2 | |
Made public in 2022.1 | |
Made public in 2024.2 | |
Made public in 2021.2/3 | |
Made public in 2023.1 | |
Made public in 2023.2 | |
Made public in 2021.3 | |
Made public in 2023.3 | |
| Made public in 2022.1 |
| YAML Metadata API will be made public in 2023.1 |