4e802980f2
* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26 * [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles * [webhelp] Fixes for Part #5 TXP00017 * [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin". * [webhelp] Removed numbers from page section titles in rest of project *.md files. * [new webhelp] Build #44 changes * [new webhelp] Maintenance merge from master * [new webhelp] Add placeholder file for webhelp import. * [webhelp] Correct redirects for file name changes * [webhelp] TOC not needed in webhelp * [format] {:toc} not needed for webhelp * add {:disable-links} to ensure demo links are not interpreted as real links. * Put all badges on the same line to simplify composition. * formatter.md: fix upsource link * fix some links * api_changes_list.md: remove note * migrate to webhelp - initial * fix GH edit URL * remove sdkdocs-template setup in VCS config * remove recently_updated.md * restore COC/CONTRIBUTING.md * api_changes_list.md: remove note * useful_links.md: IPE Co-authored-by: JohnHake <john.hake@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
3.5 KiB
Every project uses a Software Development Kit (SDK). For Java projects, the SDK is referred to as the JDK (Java Development Kit). The SDK determines which API library is used to build the project. If a project is multi-module, the project SDK by default is common for all modules within the project. Optionally, individual SDKs for each module can be configured. For more information about SDKs, see SDK in the IntelliJ IDEA Web Help.
Getting Project SDK Information
The information about the project SDK is accessed via ProjectRootManager like the following example shows
Sdk projectSdk = ProjectRootManager.getInstance(project).getProjectSdk();
Getting and Setting Project SDK Attributes
-
To get the project level SDK
Sdk projectSDK = ProjectRootManager.getInstance(project).getProjectSdk(); -
To get the project level SDK name:
String projectSDKName = ProjectRootManager.getInstance(project).getProjectSdkName(); -
To set the project level SDK:
ProjectRootManager.getInstance(project).setProjectSdk(Sdk jdk); -
To set the project level SDK name:
ProjectRootManager.getInstance(project).setProjectSdkName(String name);
See the project_model code sample to get more familiar with SDK manipulation toolset.
Available SDKs
ProjectJdkTable can be used to query and modify configured SDKs.
Working with a Custom SDK
To create a custom SDK, provide a class extending SdkType, leave saveAdditionalData() blank, and register it in the com.intellij.sdkType extension point.
To make SDK settings persistent, override setupSdkPaths() and save settings by modificator.commitChanges():
@Override
public boolean setupSdkPaths(@NotNull Sdk sdk, @NotNull SdkModel sdkModel) {
SdkModificator modificator = sdk.getSdkModificator();
modificator.setVersionString(getVersionString(sdk));
modificator.commitChanges(); // save
return true;
}
To let a user select an SDK, see ProjectJdksEditor.
However, it is not recommended to use "SDK" in non-IntelliJ IDEA IDEs.
Although "SDK" is available in most JetBrains products, ProjectJdksEditor is specific to Java, making the operation around "SDK" difficult.
The recommended way of managing "SDK" settings is to create a CustomStepProjectGenerator implementation and save settings in a PersistentStateComponent.
Assisting in Setting Up an SDK
Register the implementation of ProjectSdkSetupValidator in extension point com.intellij.projectSdkSetupValidator to provide quick fix.