Package com.intellij.openapi.roots.ui.configuration.projectRoot

Interface SdkDownloadTask

public interface SdkDownloadTask

Implement that interface and return an instance back via the callback of the SdkDownload.showDownloadUI(SdkTypeId, SdkModel, JComponent, Sdk, Consumer) method to register an SDK in the model and to initiate a background process of downloading and preparing of it.

See Also:

SdkDownload

Method Summary

Modifier and Type	Method and Description
void	doDownload(ProgressIndicator indicator) Executes the task in a background thread to download and install a proposed SDK.
java.lang.String	getPlannedHomeDir()
java.lang.String	getPlannedVersion()
java.lang.String	getSuggestedSdkName()

Method Detail

getSuggestedSdkName

java.lang.String getSuggestedSdkName()

Returns:

suggested name for an SDK to be created, still, the name could be altered to avoid conflicts

getPlannedHomeDir

java.lang.String getPlannedHomeDir()

Returns:

SDK is expected to have a system dependent home directory. Return the planned canonical directory path where the SDK will be installed by doDownload(ProgressIndicator), that path will later be seen from Sdk.getHomePath()

getPlannedVersion

java.lang.String getPlannedVersion()

Returns:

it is helpful for the UI to know the version of the SDK beforehand (e.g. while the SDK is downloading)

doDownload

void doDownload(ProgressIndicator indicator)

Executes the task in a background thread to download and install a proposed SDK. Once completed, we will set up the SDK the same way as it is installed from a home path.
Should the task fail — the SDK will be rejected, and the message from the thrown exception will be shown to the user; make sure the exception message is ready to be presented (some details could be still hidden in the Throwable.cause field)
Implementation should do ProgressIndicator.checkCanceled() to check for a cancellation request