Package com.intellij.openapi.externalSystem.util

Class ExternalSystemUtil

java.lang.Object

com.intellij.openapi.externalSystem.util.ExternalSystemUtil

public final class ExternalSystemUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	HASHING_STRATEGY

Method Summary

Modifier and Type	Method and Description
static BuildEvent	convert(ExternalSystemTaskExecutionEvent taskExecutionEvent)
static ExecutionEnvironment	createExecutionEnvironment(Project project, ProjectSystemId externalSystemId, ExternalSystemTaskExecutionSettings taskSettings, java.lang.String executorId)
static RunnerAndConfigurationSettings	createExternalSystemRunnerAndConfigurationSettings(ExternalSystemTaskExecutionSettings taskSettings, Project project, ProjectSystemId externalSystemId)
static FailureResultImpl	createFailureResult(java.lang.String title, java.lang.Exception exception, ProjectSystemId externalSystemId, Project project, DataProvider dataProvider)
static ToolWindow	ensureToolWindowContentInitialized(Project project, ProjectSystemId externalSystemId)
static void	ensureToolWindowInitialized(Project project, ProjectSystemId externalSystemId)
static int	fileHashCode(java.io.File file)
static boolean	filesEqual(java.io.File file1, java.io.File file2)
static AbstractExternalSystemTaskConfigurationType	findConfigurationType(ProjectSystemId externalSystemId)
static VirtualFile	findLocalFileByPath(java.lang.String path)
static ExternalSystemExecutionConsoleManager<ExternalSystemRunConfiguration,ExecutionConsole,ProcessHandler>	getConsoleManagerFor(ExternalSystemTask task)
static ExternalProjectInfo	getExternalProjectInfo(Project project, ProjectSystemId projectSystemId, java.lang.String externalProjectPath)
static java.lang.String	getRunnerId(java.lang.String executorId)
static void	invokeLater(Project p, ModalityState state, java.lang.Runnable r)
static void	invokeLater(Project p, java.lang.Runnable r)
static boolean	isNewProject(Project project)
static boolean	isNoBackgroundMode()
static void	linkExternalProject(ProjectSystemId externalSystemId, ExternalProjectSettings projectSettings, Project project, Consumer<? super java.lang.Boolean> importResultCallback, boolean isPreviewMode, ProgressExecutionMode progressExecutionMode) Tries to obtain external project info implied by the given settings and link that external project to the given ide project.
static VirtualFile	refreshAndFindFileByIoFile(java.io.File file)
static void	refreshProject(Project project, ProjectSystemId externalSystemId, java.lang.String externalProjectPath, boolean isPreviewMode, ProgressExecutionMode progressExecutionMode)
static void	refreshProject(Project project, ProjectSystemId externalSystemId, java.lang.String externalProjectPath, ExternalProjectRefreshCallback callback, boolean isPreviewMode, ProgressExecutionMode progressExecutionMode) Import external project.
static void	refreshProject(Project project, ProjectSystemId externalSystemId, java.lang.String externalProjectPath, ExternalProjectRefreshCallback callback, boolean isPreviewMode, ProgressExecutionMode progressExecutionMode, boolean reportRefreshError) Import external project.
static void	refreshProject(java.lang.String externalProjectPath, ImportSpec importSpec)
static void	refreshProject(java.lang.String externalProjectPath, ImportSpecBuilder importSpecBuilder)
static void	refreshProjects(ImportSpec spec) Asks to refresh all external projects of the target external system linked to the given ide project based on provided spec
static void	refreshProjects(ImportSpecBuilder specBuilder) Asks to refresh all external projects of the target external system linked to the given ide project based on provided spec
static void	refreshProjects(Project project, ProjectSystemId externalSystemId, boolean force) Deprecated. use refreshProjects(ImportSpecBuilder)
static void	refreshProjects(Project project, ProjectSystemId externalSystemId, boolean force, ProgressExecutionMode progressExecutionMode) Deprecated. use refreshProjects(ImportSpecBuilder)
static void	runTask(ExternalSystemTaskExecutionSettings taskSettings, java.lang.String executorId, Project project, ProjectSystemId externalSystemId)
static void	runTask(ExternalSystemTaskExecutionSettings taskSettings, java.lang.String executorId, Project project, ProjectSystemId externalSystemId, TaskCallback callback, ProgressExecutionMode progressExecutionMode)
static void	runTask(ExternalSystemTaskExecutionSettings taskSettings, java.lang.String executorId, Project project, ProjectSystemId externalSystemId, TaskCallback callback, ProgressExecutionMode progressExecutionMode, boolean activateToolWindowBeforeRun)
static void	runTask(ExternalSystemTaskExecutionSettings taskSettings, java.lang.String executorId, Project project, ProjectSystemId externalSystemId, TaskCallback callback, ProgressExecutionMode progressExecutionMode, boolean activateToolWindowBeforeRun, UserDataHolderBase userData)
static void	scheduleExternalViewStructureUpdate(Project project, ProjectSystemId systemId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HASHING_STRATEGY

public static final <any> HASHING_STRATEGY

Method Detail

fileHashCode

public static int fileHashCode(java.io.File file)

filesEqual

public static boolean filesEqual(java.io.File file1,
                                 java.io.File file2)

ensureToolWindowInitialized

public static void ensureToolWindowInitialized(Project project,
                                               ProjectSystemId externalSystemId)

ensureToolWindowContentInitialized

public static ToolWindow ensureToolWindowContentInitialized(Project project,
                                                            ProjectSystemId externalSystemId)

refreshProjects

@Deprecated
public static void refreshProjects(Project project,
                                   ProjectSystemId externalSystemId,
                                   boolean force)

Deprecated. use refreshProjects(ImportSpecBuilder)

Asks to refresh all external projects of the target external system linked to the given ide project.

'Refresh' here means 'obtain the most up-to-date version and apply it to the ide'.

Parameters:

project - target ide project

externalSystemId - target external system which projects should be refreshed

force - flag which defines if external project refresh should be performed if it's config is up-to-date

refreshProjects

@Deprecated
public static void refreshProjects(Project project,
                                   ProjectSystemId externalSystemId,
                                   boolean force,
                                   ProgressExecutionMode progressExecutionMode)

Deprecated. use refreshProjects(ImportSpecBuilder)

Asks to refresh all external projects of the target external system linked to the given ide project.

'Refresh' here means 'obtain the most up-to-date version and apply it to the ide'.

Parameters:

project - target ide project

externalSystemId - target external system which projects should be refreshed

force - flag which defines if external project refresh should be performed if it's config is up-to-date

refreshProjects

public static void refreshProjects(ImportSpecBuilder specBuilder)

Asks to refresh all external projects of the target external system linked to the given ide project based on provided spec

Parameters:

specBuilder - import specification builder

refreshProjects

public static void refreshProjects(ImportSpec spec)

Asks to refresh all external projects of the target external system linked to the given ide project based on provided spec

Parameters:

spec - import specification

refreshProject

public static void refreshProject(Project project,
                                  ProjectSystemId externalSystemId,
                                  java.lang.String externalProjectPath,
                                  boolean isPreviewMode,
                                  ProgressExecutionMode progressExecutionMode)

refreshProject

public static void refreshProject(Project project,
                                  ProjectSystemId externalSystemId,
                                  java.lang.String externalProjectPath,
                                  ExternalProjectRefreshCallback callback,
                                  boolean isPreviewMode,
                                  ProgressExecutionMode progressExecutionMode)

Import external project.

Parameters:

project - target intellij project to use

externalProjectPath - path of the target external project's file

callback - callback to be notified on refresh result

isPreviewMode - flag that identifies whether libraries should be resolved during the refresh

refreshProject

public static void refreshProject(Project project,
                                  ProjectSystemId externalSystemId,
                                  java.lang.String externalProjectPath,
                                  ExternalProjectRefreshCallback callback,
                                  boolean isPreviewMode,
                                  ProgressExecutionMode progressExecutionMode,
                                  boolean reportRefreshError)

Import external project.

Parameters:

project - target intellij project to use

externalProjectPath - path of the target external project

callback - callback to be notified on refresh result

isPreviewMode - flag that identifies whether libraries should be resolved during the refresh

reportRefreshError - prevent to show annoying error notification, e.g. if auto-import mode used

refreshProject

public static void refreshProject(java.lang.String externalProjectPath,
                                  ImportSpecBuilder importSpecBuilder)

refreshProject

public static void refreshProject(java.lang.String externalProjectPath,
                                  ImportSpec importSpec)

isNewProject

public static boolean isNewProject(Project project)

createFailureResult

public static FailureResultImpl createFailureResult(java.lang.String title,
                                                    java.lang.Exception exception,
                                                    ProjectSystemId externalSystemId,
                                                    Project project,
                                                    DataProvider dataProvider)

convert

public static BuildEvent convert(ExternalSystemTaskExecutionEvent taskExecutionEvent)

runTask

public static void runTask(ExternalSystemTaskExecutionSettings taskSettings,
                           java.lang.String executorId,
                           Project project,
                           ProjectSystemId externalSystemId)

runTask

public static void runTask(ExternalSystemTaskExecutionSettings taskSettings,
                           java.lang.String executorId,
                           Project project,
                           ProjectSystemId externalSystemId,
                           TaskCallback callback,
                           ProgressExecutionMode progressExecutionMode)

runTask

public static void runTask(ExternalSystemTaskExecutionSettings taskSettings,
                           java.lang.String executorId,
                           Project project,
                           ProjectSystemId externalSystemId,
                           TaskCallback callback,
                           ProgressExecutionMode progressExecutionMode,
                           boolean activateToolWindowBeforeRun)

runTask

public static void runTask(ExternalSystemTaskExecutionSettings taskSettings,
                           java.lang.String executorId,
                           Project project,
                           ProjectSystemId externalSystemId,
                           TaskCallback callback,
                           ProgressExecutionMode progressExecutionMode,
                           boolean activateToolWindowBeforeRun,
                           UserDataHolderBase userData)

createExecutionEnvironment

public static ExecutionEnvironment createExecutionEnvironment(Project project,
                                                              ProjectSystemId externalSystemId,
                                                              ExternalSystemTaskExecutionSettings taskSettings,
                                                              java.lang.String executorId)

createExternalSystemRunnerAndConfigurationSettings

public static RunnerAndConfigurationSettings createExternalSystemRunnerAndConfigurationSettings(ExternalSystemTaskExecutionSettings taskSettings,
                                                                                                Project project,
                                                                                                ProjectSystemId externalSystemId)

findConfigurationType

public static AbstractExternalSystemTaskConfigurationType findConfigurationType(ProjectSystemId externalSystemId)

getRunnerId

public static java.lang.String getRunnerId(java.lang.String executorId)

linkExternalProject

public static void linkExternalProject(ProjectSystemId externalSystemId,
                                       ExternalProjectSettings projectSettings,
                                       Project project,
                                       Consumer<? super java.lang.Boolean> importResultCallback,
                                       boolean isPreviewMode,
                                       ProgressExecutionMode progressExecutionMode)

Tries to obtain external project info implied by the given settings and link that external project to the given ide project.

Parameters:

externalSystemId - target external system

projectSettings - settings of the external project to link

project - target ide project to link external project to

importResultCallback - it might take a while to resolve external project info, that's why it's possible to provide a callback to be notified on processing result. It receives true if an external project info has been successfully obtained, false otherwise.

isPreviewMode - flag which identifies if missing external project binaries should be downloaded

progressExecutionMode - identifies how progress bar will be represented for the current processing

refreshAndFindFileByIoFile

public static VirtualFile refreshAndFindFileByIoFile(java.io.File file)

findLocalFileByPath

public static VirtualFile findLocalFileByPath(java.lang.String path)

scheduleExternalViewStructureUpdate

public static void scheduleExternalViewStructureUpdate(Project project,
                                                       ProjectSystemId systemId)

getExternalProjectInfo

public static ExternalProjectInfo getExternalProjectInfo(Project project,
                                                         ProjectSystemId projectSystemId,
                                                         java.lang.String externalProjectPath)

getConsoleManagerFor

public static ExternalSystemExecutionConsoleManager<ExternalSystemRunConfiguration,ExecutionConsole,ProcessHandler> getConsoleManagerFor(ExternalSystemTask task)

invokeLater

public static void invokeLater(Project p,
                               java.lang.Runnable r)

invokeLater

public static void invokeLater(Project p,
                               ModalityState state,
                               java.lang.Runnable r)

isNoBackgroundMode

public static boolean isNoBackgroundMode()