Package com.intellij.openapi.externalSystem

Interface ExternalSystemManager<ProjectSettings extends ExternalProjectSettings,SettingsListener extends ExternalSystemSettingsListener<ProjectSettings>,Settings extends AbstractExternalSystemSettings<Settings,ProjectSettings,SettingsListener>,LocalSettings extends AbstractExternalSystemLocalSettings,ExecutionSettings extends ExternalSystemExecutionSettings>

All Superinterfaces:

ParametersEnhancer

All Known Implementing Classes:

GradleManager

public interface ExternalSystemManager<ProjectSettings extends ExternalProjectSettings,SettingsListener extends ExternalSystemSettingsListener<ProjectSettings>,Settings extends AbstractExternalSystemSettings<Settings,ProjectSettings,SettingsListener>,LocalSettings extends AbstractExternalSystemLocalSettings,ExecutionSettings extends ExternalSystemExecutionSettings>
extends ParametersEnhancer

IntelliJ external systems integration is built using GoF Bridge pattern, i.e. 'external-system' module defines external system-specific extension (current interface) and an api which is used by all extensions. Most of the codebase is built on top of that api and provides generic actions like 'sync ide project with external project'; 'import library dependencies which are configured at external system but not at the ide' etc.

That makes it relatively easy to add a new external system integration.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ExternalSystemManager<?,?,?,?,?>>	EP_NAME

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	createTestConsoleProperties(Project project, Executor executor, RunConfiguration runConfiguration) Deprecated. to be removed in IDEA 2020, implement SMRunnerConsolePropertiesProvider for your ExternalSystemRunConfiguration instead
Function<Pair<Project,java.lang.String>,ExecutionSettings>	getExecutionSettingsProvider()
FileChooserDescriptor	getExternalProjectDescriptor()
Function<Project,LocalSettings>	getLocalSettingsProvider()
java.lang.Class<? extends ExternalSystemProjectResolver<ExecutionSettings>>	getProjectResolverClass() Allows to retrieve information about project resolver to use for the target external system.
default GlobalSearchScope	getSearchScope(Project project, ExternalSystemTaskExecutionSettings taskExecutionSettings)
Function<Project,Settings>	getSettingsProvider()
ProjectSystemId	getSystemId()
java.lang.Class<? extends ExternalSystemTaskManager<ExecutionSettings>>	getTaskManagerClass()

Methods inherited from interface com.intellij.openapi.externalSystem.service.ParametersEnhancer

enhanceRemoteProcessing

Field Detail

EP_NAME

static final ExtensionPointName<ExternalSystemManager<?,?,?,?,?>> EP_NAME

Method Detail

getSystemId

ProjectSystemId getSystemId()

Returns:

id of the external system represented by the current manager

getSettingsProvider

Function<Project,Settings> getSettingsProvider()

Returns:

a strategy which can be queried for external system settings to use with the given project

getLocalSettingsProvider

Function<Project,LocalSettings> getLocalSettingsProvider()

Returns:

a strategy which can be queried for external system local settings to use with the given project

getExecutionSettingsProvider

Function<Pair<Project,java.lang.String>,ExecutionSettings> getExecutionSettingsProvider()

Returns:

a strategy which can be queried for external system execution settings to use with the given project

getProjectResolverClass

java.lang.Class<? extends ExternalSystemProjectResolver<ExecutionSettings>> getProjectResolverClass()

Allows to retrieve information about project resolver to use for the target external system.

Note: we return a class instance instead of resolver object here because there is a possible case that the resolver is used at external (non-ide) process, so, it needs information which is enough for instantiating it there. That implies the requirement that target resolver class is expected to have a no-args constructor

Returns:

class of the project resolver to use for the target external system

getTaskManagerClass

java.lang.Class<? extends ExternalSystemTaskManager<ExecutionSettings>> getTaskManagerClass()

Returns:

class of the build manager to use for the target external system

See Also:

getProjectResolverClass()

getExternalProjectDescriptor

FileChooserDescriptor getExternalProjectDescriptor()

Returns:

file chooser descriptor to use when adding new external project

getSearchScope

default GlobalSearchScope getSearchScope(Project project,
                                         ExternalSystemTaskExecutionSettings taskExecutionSettings)

Returns:

scope where to search sources for external system tasks execution

createTestConsoleProperties

@Deprecated
default java.lang.Object createTestConsoleProperties(Project project,
                                                     Executor executor,
                                                     RunConfiguration runConfiguration)

Deprecated. to be removed in IDEA 2020, implement SMRunnerConsolePropertiesProvider for your ExternalSystemRunConfiguration instead

Returns:

SMTRunnerConsoleProperties to integrate external system test runner with the 'Import Tests Results' action