Package com.intellij.openapi.externalSystem.util

Class ExternalSystemApiUtil

java.lang.Object

com.intellij.openapi.externalSystem.util.ExternalSystemApiUtil

public class ExternalSystemApiUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.lang.Object>	ORDER_AWARE_COMPARATOR
static java.lang.String	PATH_SEPARATOR

Method Summary

Modifier and Type	Method and Description
static void	addBundle(PathsList classPath, java.lang.String bundlePath, java.lang.Class<?> contextClass) Configures given classpath to reference target i18n bundle file(s).
static void	addToInvokeLater(java.lang.Runnable runnable) Adds runnable to Event Dispatch Queue if we aren't in UnitTest of Headless environment mode
static java.lang.String	buildErrorMessage(java.lang.Throwable e) unwraps given exception if possible and builds error message for it.
static <T> T	doWriteAction(Computable<T> task)
static void	doWriteAction(java.lang.Runnable task)
static void	executeOnEdt(boolean synchronous, java.lang.Runnable task)
static <T> T	executeOnEdt(Computable<T> task)
static void	executeProjectChangeAction(boolean synchronous, DisposeAwareProjectChange task)
static void	executeProjectChangeAction(DisposeAwareProjectChange task)
static java.lang.String	extractNameFromPath(java.lang.String path)
static <T> DataNode<T>	find(DataNode<?> node, Key<T> key)
static <T> DataNode<T>	find(DataNode<?> node, Key<T> key, BooleanFunction<? super DataNode<T>> predicate)
static <T> java.util.Collection<DataNode<T>>	findAll(DataNode<?> parent, Key<T> key)
static java.util.Collection<DataNode<?>>	findAllRecursively(java.util.Collection<? extends DataNode<?>> nodes)
static java.util.Collection<DataNode<?>>	findAllRecursively(java.util.Collection<? extends DataNode<?>> nodes, BooleanFunction<? super DataNode<?>> predicate)
static java.util.Collection<DataNode<?>>	findAllRecursively(DataNode<?> node, BooleanFunction<? super DataNode<?>> predicate)
static <T> java.util.Collection<DataNode<T>>	findAllRecursively(DataNode<?> node, Key<T> key)
static DataNode<?>	findFirstRecursively(java.util.Collection<? extends DataNode<?>> nodes, BooleanFunction<? super DataNode<?>> predicate)
static DataNode<?>	findFirstRecursively(DataNode<?> parentNode, BooleanFunction<? super DataNode<?>> predicate)
static <T> DataNode<T>	findParent(DataNode<?> node, Key<T> key)
static <T> DataNode<T>	findParent(DataNode<?> node, Key<T> key, BooleanFunction<? super DataNode<T>> predicate)
static DataNode<ProjectData>	findProjectData(Project project, ProjectSystemId systemId, java.lang.String projectPath)
static ExternalProjectInfo	findProjectInfo(Project project, ProjectSystemId systemId, java.lang.String projectPath)
static java.util.Collection<TaskData>	findProjectTasks(Project project, ProjectSystemId systemId, java.lang.String projectPath)
static java.util.List<ExternalSystemManager<?,?,?,?,?>>	getAllManagers()
static <T> java.util.Collection<DataNode<T>>	getChildren(DataNode<?> node, Key<T> key)
static <S extends ExternalSystemExecutionSettings> S	getExecutionSettings(Project project, java.lang.String linkedProjectPath, ProjectSystemId externalSystemId)
static java.lang.String	getExternalModuleType(Module module)
static java.lang.String	getExternalProjectGroup(Module module)
static java.lang.String	getExternalProjectId(Module module)
static java.lang.String	getExternalProjectPath(Module module)
static java.lang.String	getExternalProjectVersion(Module module)
static java.lang.String	getExternalRootProjectPath(Module module)
static java.lang.String	getLibraryName(Library library)
static java.lang.String	getLocalFileSystemPath(VirtualFile file)
static <S extends AbstractExternalSystemLocalSettings> S	getLocalSettings(Project project, ProjectSystemId externalSystemId)
static ExternalSystemManager<?,?,?,?,?>	getManager(ProjectSystemId externalSystemId)
static java.lang.String	getProjectRepresentationName(java.lang.String targetProjectPath, java.lang.String rootProjectPath)
static java.lang.String	getRootProjectPath(java.lang.String externalProjectPath, ProjectSystemId externalSystemId, Project project) There is a possible case that external project linked to an ide project is a multi-project, i.e.
static AbstractExternalSystemSettings	getSettings(Project project, ProjectSystemId externalSystemId)
static MultiMap<Key<?>,DataNode<?>>	group(java.util.Collection<? extends DataNode<?>> nodes)
static <K,V> MultiMap<DataNode<K>,DataNode<V>>	groupBy(java.util.Collection<? extends DataNode<V>> nodes, java.lang.Class<K> moduleDataClass)
static <K,V> MultiMap<DataNode<K>,DataNode<V>>	groupBy(java.util.Collection<? extends DataNode<V>> nodes, Key<K> key)
static boolean	isExternalSystemAwareModule(ProjectSystemId systemId, Module module)
static boolean	isExternalSystemAwareModule(java.lang.String systemId, Module module)
static boolean	isExternalSystemLibrary(Library library, ProjectSystemId externalSystemId)
static boolean	isInProcessMode(ProjectSystemId externalSystemId) Historically we prefer to work with third-party api not from ide process but from dedicated slave process (there is a risk that third-party api has bugs which might make the whole ide process corrupted, e.g.
static boolean	isOneToOneMapping(Project ideProject, ProjectData projectData, Module[] modules) Allows to answer if given ide project has 1-1 mapping with the given external project, i.e.
static boolean	isRelated(Library library, LibraryData libraryData)
static java.lang.String	normalizePath(java.lang.String s)
static void	orderAwareSort(java.util.List<?> data)
static MultiMap<Key<?>,DataNode<?>>	recursiveGroup(java.util.Collection<DataNode<?>> nodes)
static java.lang.String	stacktraceAsString(java.lang.Throwable throwable)
static void	subscribe(Project project, ProjectSystemId systemId, ExternalSystemSettingsListener listener)
static void	subscribe(Project project, ProjectSystemId systemId, ExternalSystemSettingsListener listener, Disposable parentDisposable)
static java.lang.String	toCanonicalPath(java.lang.String path)
static ProjectModelExternalSource	toExternalSource(ProjectSystemId systemId)
static void	visit(DataNode<?> originalNode, java.util.function.Consumer<? super DataNode<?>> consumer)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

ORDER_AWARE_COMPARATOR

public static final java.util.Comparator<java.lang.Object> ORDER_AWARE_COMPARATOR

Method Detail

extractNameFromPath

public static java.lang.String extractNameFromPath(java.lang.String path)

getLibraryName

public static java.lang.String getLibraryName(Library library)

isRelated

public static boolean isRelated(Library library,
                                LibraryData libraryData)

isExternalSystemLibrary

public static boolean isExternalSystemLibrary(Library library,
                                              ProjectSystemId externalSystemId)

orderAwareSort

public static void orderAwareSort(java.util.List<?> data)

toCanonicalPath

public static java.lang.String toCanonicalPath(java.lang.String path)

Parameters:

path - target path

Returns:

absolute path that points to the same location as the given one and that uses only slashes

getLocalFileSystemPath

public static java.lang.String getLocalFileSystemPath(VirtualFile file)

getManager

public static ExternalSystemManager<?,?,?,?,?> getManager(ProjectSystemId externalSystemId)

getAllManagers

public static java.util.List<ExternalSystemManager<?,?,?,?,?>> getAllManagers()

recursiveGroup

public static MultiMap<Key<?>,DataNode<?>> recursiveGroup(java.util.Collection<DataNode<?>> nodes)

group

public static MultiMap<Key<?>,DataNode<?>> group(java.util.Collection<? extends DataNode<?>> nodes)

groupBy

public static <K,V> MultiMap<DataNode<K>,DataNode<V>> groupBy(java.util.Collection<? extends DataNode<V>> nodes,
                                                              java.lang.Class<K> moduleDataClass)

groupBy

public static <K,V> MultiMap<DataNode<K>,DataNode<V>> groupBy(java.util.Collection<? extends DataNode<V>> nodes,
                                                              Key<K> key)

getChildren

public static <T> java.util.Collection<DataNode<T>> getChildren(DataNode<?> node,
                                                                Key<T> key)

find

public static <T> DataNode<T> find(DataNode<?> node,
                                   Key<T> key)

find

public static <T> DataNode<T> find(DataNode<?> node,
                                   Key<T> key,
                                   BooleanFunction<? super DataNode<T>> predicate)

findParent

public static <T> DataNode<T> findParent(DataNode<?> node,
                                         Key<T> key)

findParent

public static <T> DataNode<T> findParent(DataNode<?> node,
                                         Key<T> key,
                                         BooleanFunction<? super DataNode<T>> predicate)

findAll

public static <T> java.util.Collection<DataNode<T>> findAll(DataNode<?> parent,
                                                            Key<T> key)

visit

public static void visit(DataNode<?> originalNode,
                         java.util.function.Consumer<? super DataNode<?>> consumer)

findAllRecursively

public static <T> java.util.Collection<DataNode<T>> findAllRecursively(DataNode<?> node,
                                                                       Key<T> key)

findAllRecursively

public static java.util.Collection<DataNode<?>> findAllRecursively(java.util.Collection<? extends DataNode<?>> nodes)

findAllRecursively

public static java.util.Collection<DataNode<?>> findAllRecursively(DataNode<?> node,
                                                                   BooleanFunction<? super DataNode<?>> predicate)

findAllRecursively

public static java.util.Collection<DataNode<?>> findAllRecursively(java.util.Collection<? extends DataNode<?>> nodes,
                                                                   BooleanFunction<? super DataNode<?>> predicate)

findFirstRecursively

public static DataNode<?> findFirstRecursively(DataNode<?> parentNode,
                                               BooleanFunction<? super DataNode<?>> predicate)

findFirstRecursively

public static DataNode<?> findFirstRecursively(java.util.Collection<? extends DataNode<?>> nodes,
                                               BooleanFunction<? super DataNode<?>> predicate)

executeProjectChangeAction

public static void executeProjectChangeAction(DisposeAwareProjectChange task)

executeProjectChangeAction

public static void executeProjectChangeAction(boolean synchronous,
                                              DisposeAwareProjectChange task)

executeOnEdt

public static void executeOnEdt(boolean synchronous,
                                java.lang.Runnable task)

executeOnEdt

public static <T> T executeOnEdt(Computable<T> task)

doWriteAction

public static <T> T doWriteAction(Computable<T> task)

doWriteAction

public static void doWriteAction(java.lang.Runnable task)

addToInvokeLater

public static void addToInvokeLater(java.lang.Runnable runnable)

Adds runnable to Event Dispatch Queue if we aren't in UnitTest of Headless environment mode

Parameters:

runnable - Runnable

addBundle

public static void addBundle(PathsList classPath,
                             java.lang.String bundlePath,
                             java.lang.Class<?> contextClass)

Configures given classpath to reference target i18n bundle file(s).

Parameters:

classPath - process classpath

bundlePath - path to the target bundle file

contextClass - class from the same content root as the target bundle file

normalizePath

public static java.lang.String normalizePath(java.lang.String s)

isOneToOneMapping

public static boolean isOneToOneMapping(Project ideProject,
                                        ProjectData projectData,
                                        Module[] modules)

Allows to answer if given ide project has 1-1 mapping with the given external project, i.e. the ide project has been imported from external system and no other external projects have been added.

This might be necessary in a situation when project-level setting is changed (e.g. project name). We don't want to rename ide project if it doesn't completely corresponds to the given ide project then.

Parameters:

ideProject - target ide project

projectData - target external project

modules - the list of modules to check (during import this contains uncommitted modules from the modifiable model)

Returns:

true if given ide project has 1-1 mapping to the given external project; false otherwise

getProjectRepresentationName

public static java.lang.String getProjectRepresentationName(java.lang.String targetProjectPath,
                                                            java.lang.String rootProjectPath)

getRootProjectPath

public static java.lang.String getRootProjectPath(java.lang.String externalProjectPath,
                                                  ProjectSystemId externalSystemId,
                                                  Project project)

There is a possible case that external project linked to an ide project is a multi-project, i.e. contains more than one module.

This method tries to find root project's config path assuming that given path points to a sub-project's config path.

Parameters:

externalProjectPath - external sub-project's config path

externalSystemId - target external system

project - target ide project

Returns:

root external project's path if given path is considered to point to a known sub-project's config; null if it's not possible to find a root project's config path on the basis of the given path

buildErrorMessage

public static java.lang.String buildErrorMessage(java.lang.Throwable e)

unwraps given exception if possible and builds error message for it.

Parameters:

e - exception to process

Returns:

error message for the given exception

stacktraceAsString

public static java.lang.String stacktraceAsString(java.lang.Throwable throwable)

getSettings

public static AbstractExternalSystemSettings getSettings(Project project,
                                                         ProjectSystemId externalSystemId)
                                                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getLocalSettings

public static <S extends AbstractExternalSystemLocalSettings> S getLocalSettings(Project project,
                                                                                 ProjectSystemId externalSystemId)
                                                                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getExecutionSettings

public static <S extends ExternalSystemExecutionSettings> S getExecutionSettings(Project project,
                                                                                 java.lang.String linkedProjectPath,
                                                                                 ProjectSystemId externalSystemId)
                                                                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

isInProcessMode

public static boolean isInProcessMode(ProjectSystemId externalSystemId)

Historically we prefer to work with third-party api not from ide process but from dedicated slave process (there is a risk that third-party api has bugs which might make the whole ide process corrupted, e.g. a memory leak at the api might crash the whole ide process).

However, we do allow to explicitly configure the ide to work with third-party external system api from the ide process.

This method allows to check whether the ide is configured to use 'out of process' or 'in process' mode for the system.

Parameters:

externalSystemId - target external system

Returns:

true if the ide is configured to work with external system api from the ide process; false otherwise

toExternalSource

public static ProjectModelExternalSource toExternalSource(ProjectSystemId systemId)

isExternalSystemAwareModule

public static boolean isExternalSystemAwareModule(ProjectSystemId systemId,
                                                  Module module)

isExternalSystemAwareModule

public static boolean isExternalSystemAwareModule(java.lang.String systemId,
                                                  Module module)

getExternalProjectPath

public static java.lang.String getExternalProjectPath(Module module)

getExternalRootProjectPath

public static java.lang.String getExternalRootProjectPath(Module module)

getExternalProjectId

public static java.lang.String getExternalProjectId(Module module)

getExternalProjectGroup

public static java.lang.String getExternalProjectGroup(Module module)

getExternalProjectVersion

public static java.lang.String getExternalProjectVersion(Module module)

getExternalModuleType

public static java.lang.String getExternalModuleType(Module module)

subscribe

public static void subscribe(Project project,
                             ProjectSystemId systemId,
                             ExternalSystemSettingsListener listener)

subscribe

public static void subscribe(Project project,
                             ProjectSystemId systemId,
                             ExternalSystemSettingsListener listener,
                             Disposable parentDisposable)

findProjectTasks

public static java.util.Collection<TaskData> findProjectTasks(Project project,
                                                              ProjectSystemId systemId,
                                                              java.lang.String projectPath)

findProjectData

public static DataNode<ProjectData> findProjectData(Project project,
                                                    ProjectSystemId systemId,
                                                    java.lang.String projectPath)

findProjectInfo

public static ExternalProjectInfo findProjectInfo(Project project,
                                                  ProjectSystemId systemId,
                                                  java.lang.String projectPath)