Package com.intellij.openapi.externalSystem

Interface ExternalSystemAutoImportAware

All Known Implementing Classes:

CachingExternalSystemAutoImportAware, GradleAutoImportAware, GradleManager

public interface ExternalSystemAutoImportAware

External system integration provides 'auto-import' feature, i.e. it listens for external system config files changes and automatically runs external project refresh and sync.

Only registered project's config files are processed by default. However, there is a possible case that there are other auxiliary config files/directories which modification should trigger external project refresh. This interface is supposed to handle that situation, i.e. any external system implementation which requires the functionality described above should implement this interface.

Method Summary

Modifier and Type	Method and Description
default java.util.List<java.io.File>	getAffectedExternalProjectFiles(java.lang.String projectPath, Project project)
java.lang.String	getAffectedExternalProjectPath(java.lang.String changedFileOrDirPath, Project project) This method serves to check if particular file/dir change should trigger external project refresh.

Method Detail

getAffectedExternalProjectPath

java.lang.String getAffectedExternalProjectPath(java.lang.String changedFileOrDirPath,
                                                Project project)

This method serves to check if particular file/dir change should trigger external project refresh.

Note: there is no need to handle here external project config files known to the ide as that functionality is built-in. Only auxiliary files should be processed.

Note2: this method is assume to be called rather often, that's why it's very important to return from it quickly. Caching and simple check algorithms are welcomed.

Parameters:

changedFileOrDirPath - changed file/dir path

project - current project

Returns:

null if target change should not trigger external project refresh; path to config file of an external project which should be refreshed

getAffectedExternalProjectFiles

default java.util.List<java.io.File> getAffectedExternalProjectFiles(java.lang.String projectPath,
                                                                     Project project)