mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 01:07:49 +08:00
54 lines
6.9 KiB
Markdown
54 lines
6.9 KiB
Markdown
[//]: # (title: Internal API Migration)
|
|
|
|
<!-- Copyright 2000-2022 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 lists commonly used API annotated with [`org.jetbrains.annotations.ApiStatus.Internal`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) which indicates it's _private API_ and must not be used outside of IntelliJ Platform itself:
|
|
|
|
> _ApiStatus.Internal Javadoc_:
|
|
>
|
|
> Indicates that the annotated element (class, method, field, etc.) **must not be considered as a public API**. It's made visible to allow
|
|
> usages in other packages of the declaring library, but it **must not be used outside of that library**. Such elements
|
|
> may be renamed, changed or removed in future versions.
|
|
|
|
Such violations are reported from [Plugin Verifier](api_changes_list.md#plugin-verifier) and are highlighted in the IDE using [dedicated inspection](api_changes_list.md#ide-support).
|
|
|
|
Each entry is mapped to its corresponding _Replacement_, pointing to recommended API.
|
|
|
|
> The list is not complete and will be updated continuously. Please check corresponding code documentation when encountering API not listed below.
|
|
>
|
|
{type="tip"}
|
|
|
|
## IntelliJ Platform
|
|
|
|
| Internal API | Replacement |
|
|
|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `AnAction.applyTextOverride()` | [](basic_action_system.md#setting-the-override-text-element) |
|
|
| `ApplicationLoadListener` | See [](plugin_components.md#application-startup) |
|
|
| `BuildNumber.currentVersion()` | Use `ApplicationInfo.getBuild()` |
|
|
| `CompactVirtualFileSet` | Use `VfsUtilCore.createCompactVirtualFileSet()` |
|
|
| `DefaultPicoContainer` | Use [extension points](plugin_extensions.md) and [services](plugin_services.md) |
|
|
| `EdtDataContext` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/platform-impl/src/com/intellij/openapi/actionSystem/impl/EdtDataContext.java) |
|
|
| `FileTypeIndex.NAME` | Use static methods in `FileTypeIndex` directly |
|
|
| `IElementType.getDebugName()` | Override/use `IElementType.toString()` |
|
|
| `IconLoader.CachedImageIcon` | Use methods exposed in `IconLoader` |
|
|
| `IconLoader.LazyIcon` | Use `IconLoader.createLazy()` |
|
|
| `IndexingDataKeys` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/core-impl/src/com/intellij/util/indexing/IndexingDataKeys.java) |
|
|
| `Module.getModuleFile()` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/openapi/module/Module.java#L47) |
|
|
| `Module.getModuleFilePath()` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/openapi/module/Module.java#L47) |
|
|
| `Module.getModuleTypeName()` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/openapi/module/Module.java#L180) |
|
|
| `ModuleTypeManager.registerModuleType()` | Use `com.intellij.moduleType` extension point instead, [`ModuleType`](upsource:///platform/lang-core/src/com/intellij/openapi/module/ModuleType.java) |
|
|
| `PathMacros.setMacro()` | Use `com.intellij.pathMacroContributor` extension point, [`PathMacroContributor`](upsource:///platform/core-api/src/com/intellij/openapi/application/PathMacroContributor.java) |
|
|
| `PlatformUtils` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/util/PlatformUtils.java) |
|
|
| `PluginManager.getLogger()` | Use own logger, see [](ide_infrastructure.md#logging) |
|
|
| `ProjectLibraryTable` | Use `LibraryTablesRegistrar.getLibraryTable()` |
|
|
| `ScrollBarPainter` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/platform-api/src/com/intellij/ui/components/ScrollBarPainter.java) |
|
|
| `UtilKt.targetPresentation()` | [See Doc](https://github.com/JetBrains/intellij-community/blob/master/platform/lang-impl/src/com/intellij/codeInsight/navigation/util.kt) |
|
|
|
|
## Plugins
|
|
|
|
### Database Plugin
|
|
|
|
| Internal API | Replacement |
|
|
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `DbDataSource.getDelegate()` | For connection config use `DbDataSource.getConnectionConfig()`, for `LocalDataSource` use `DbImplUtil.getMaybeLocalDataSource(DasDataSource)` |
|