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

Interface ProjectDataService<E,I>

Type Parameters:

E - target external project data type

I - target ide project data type

All Known Implementing Classes:

AbstractDependencyDataService, AbstractModuleDataService, AbstractProjectDataService, CompositeBuildDataService, ContentRootDataService, GradleExtensionsDataService, GradleSourceSetDataService, LibraryDataService, LibraryDependencyDataService, ModuleDataService, ModuleDependencyDataService, PerformanceTraceDataService, ProjectDataServiceImpl

public interface ProjectDataService<E,I>

Defines common contract for a strategy which is able to manage project data defines in terms of 'external systems' sub-system.

Implementations of this interface are expected to be thread-safe.

Note: there is a possible case that more than one service is registered for the same key, e.g. there is a built-in generic service and a plugin provides custom extension to it. Platform calls all of them then. That means that project data service implementation must be ready to the following:

 

   
target data is already imported by another service (just no-op then);
   

     provide a hint about the order in which the services for the same key should be processed. That is done by marking
     it by Order annotation where the smaller value corresponds to earlier execution;
   
 
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
Computable<java.util.Collection<I>>	computeOrphanData(java.util.Collection<DataNode<E>> toImport, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider) Compute orphan data.
Key<E>	getTargetDataKey()
void	importData(java.util.Collection<DataNode<E>> toImport, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider) It's assumed that given data nodes present at the ide when this method returns.
default void	onFailureImport(Project project)
default void	onSuccessImport(java.util.Collection<DataNode<E>> imported, ProjectData projectData, Project project, IdeModelsProvider modelsProvider)
default void	postProcess(java.util.Collection<DataNode<E>> toImport, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider)
void	removeData(Computable<java.util.Collection<I>> toRemove, java.util.Collection<DataNode<E>> toIgnore, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider) Asks to remove all given ide project entities.

Field Detail

EP_NAME

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

Method Detail

getTargetDataKey

Key<E> getTargetDataKey()

Returns:

key of project data supported by the current manager

importData

void importData(java.util.Collection<DataNode<E>> toImport,
                ProjectData projectData,
                Project project,
                IdeModifiableModelsProvider modelsProvider)

It's assumed that given data nodes present at the ide when this method returns. I.e. the method should behave as below for every of the given data nodes:

 

   
there is an existing project entity for the given data node and it has the same state. Do nothing for it then;
   

     there is an existing project entity for the given data node but it has different state (e.g. a module dependency
     is configured as 'exported' at the ide but not at external system). Reset the state to the external system's one then;
   
   
 there is no corresponding project entity at the ide side. Create it then; 
 
 

are created, updated or left as-is if they have the

Parameters:

toImport -

project -

computeOrphanData

Computable<java.util.Collection<I>> computeOrphanData(java.util.Collection<DataNode<E>> toImport,
                                                      ProjectData projectData,
                                                      Project project,
                                                      IdeModifiableModelsProvider modelsProvider)

Compute orphan data.

removeData

void removeData(Computable<java.util.Collection<I>> toRemove,
                java.util.Collection<DataNode<E>> toIgnore,
                ProjectData projectData,
                Project project,
                IdeModifiableModelsProvider modelsProvider)

Asks to remove all given ide project entities.

Note: as more than one ProjectDataService might be configured for a target entity type, there is a possible case that the entities have already been removed when this method is called. Then it's necessary to cleanup auxiliary data (if any) or just return otherwise.

Parameters:

toRemove - project entities to remove

project - target project

postProcess

default void postProcess(java.util.Collection<DataNode<E>> toImport,
                         ProjectData projectData,
                         Project project,
                         IdeModifiableModelsProvider modelsProvider)

onSuccessImport

default void onSuccessImport(java.util.Collection<DataNode<E>> imported,
                             ProjectData projectData,
                             Project project,
                             IdeModelsProvider modelsProvider)

onFailureImport

default void onFailureImport(Project project)