Package com.intellij.openapi.externalSystem.service.project

Interface ExternalSystemProjectResolver<S extends ExternalSystemExecutionSettings>

All Known Implementing Classes:

GradleProjectResolver

public interface ExternalSystemProjectResolver<S extends ExternalSystemExecutionSettings>

Defines common interface for resolving external system project..

Method Summary

Modifier and Type	Method and Description
boolean	cancelTask(ExternalSystemTaskId taskId, ExternalSystemTaskNotificationListener listener)
default DataNode<ProjectData>	resolveProjectInfo(ExternalSystemTaskId id, java.lang.String projectPath, boolean isPreviewMode, S settings, ExternalSystemTaskNotificationListener listener) Builds object-level representation of the external system config file contained at the given path.
default DataNode<ProjectData>	resolveProjectInfo(ExternalSystemTaskId id, java.lang.String projectPath, boolean isPreviewMode, S settings, ProjectResolverPolicy resolverPolicy, ExternalSystemTaskNotificationListener listener)

Method Detail

resolveProjectInfo

default DataNode<ProjectData> resolveProjectInfo(ExternalSystemTaskId id,
                                                 java.lang.String projectPath,
                                                 boolean isPreviewMode,
                                                 S settings,
                                                 ExternalSystemTaskNotificationListener listener)
                                          throws ExternalSystemException,
                                                 java.lang.IllegalArgumentException,
                                                 java.lang.IllegalStateException

Builds object-level representation of the external system config file contained at the given path.

Parameters:

id - id of the current 'resolve project info' task

projectPath - absolute path to the target external system config file

isPreviewMode - Indicates, that an implementation can not provide/resolve any external dependencies. Only project dependencies and local file dependencies may included on the modules' classpath. And should not include any 'heavy' tasks like not trivial code generations. It is supposed to be fast.

settings - settings to use for the project resolving; null as indication that no specific settings are required

listener - callback to be notified about the execution

Returns:

object-level representation of the target external system project; null if it's not possible to resolve the project due to the objective reasons

Throws:

ExternalSystemException - in case when unexpected exception occurs during project info construction

java.lang.IllegalArgumentException - if given path is invalid

java.lang.IllegalStateException - if it's not possible to resolve target project info

resolveProjectInfo

default DataNode<ProjectData> resolveProjectInfo(ExternalSystemTaskId id,
                                                 java.lang.String projectPath,
                                                 boolean isPreviewMode,
                                                 S settings,
                                                 ProjectResolverPolicy resolverPolicy,
                                                 ExternalSystemTaskNotificationListener listener)
                                          throws ExternalSystemException,
                                                 java.lang.IllegalArgumentException,
                                                 java.lang.IllegalStateException

Throws:

ExternalSystemException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

cancelTask

boolean cancelTask(ExternalSystemTaskId taskId,
                   ExternalSystemTaskNotificationListener listener)

Parameters:

taskId - id of the 'resolve project info' task

listener - callback to be notified about the cancellation

Returns:

true if the task execution was successfully stopped, false otherwise or if target external system does not support the task cancellation