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

Class AbstractDependencyDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

java.lang.Object

com.intellij.openapi.externalSystem.service.project.manage.AbstractProjectDataService<E,I>

com.intellij.openapi.externalSystem.service.project.manage.AbstractDependencyDataService<E,I>

All Implemented Interfaces:

ProjectDataService<E,I>

Direct Known Subclasses:

LibraryDependencyDataService, ModuleDependencyDataService

public abstract class AbstractDependencyDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>
extends AbstractProjectDataService<E,I>

Field Summary

Fields inherited from class com.intellij.openapi.externalSystem.service.project.manage.AbstractProjectDataService

EMPTY_LIST

Fields inherited from interface com.intellij.openapi.externalSystem.service.project.manage.ProjectDataService

EP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyDataService()

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.
protected java.lang.String	getOrderEntryName(IdeModifiableModelsProvider modelsProvider, I orderEntry)
protected abstract java.lang.Class<I>	getOrderEntryType()
protected abstract java.util.Map<OrderEntry,OrderAware>	importData(java.util.Collection<DataNode<E>> nodesToImport, Module module, IdeModifiableModelsProvider modelsProvider)
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.
protected void	removeData(java.util.Collection<? extends ExportableOrderEntry> toRemove, Module module, IdeModifiableModelsProvider modelsProvider)
void	removeData(Computable<java.util.Collection<I>> toRemoveComputable, java.util.Collection<DataNode<E>> toIgnore, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider) Asks to remove all given ide project entities.

Methods inherited from class com.intellij.openapi.externalSystem.service.project.manage.AbstractProjectDataService

getTargetDataKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.externalSystem.service.project.manage.ProjectDataService

onFailureImport, onSuccessImport, postProcess

Constructor Detail

AbstractDependencyDataService

public AbstractDependencyDataService()

Method Detail

importData

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

Description copied from interface: ProjectDataService

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

Specified by:

importData in interface ProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

Overrides:

importData in class AbstractProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

importData

protected abstract java.util.Map<OrderEntry,OrderAware> importData(java.util.Collection<DataNode<E>> nodesToImport,
                                                                   Module module,
                                                                   IdeModifiableModelsProvider modelsProvider)

computeOrphanData

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

Description copied from interface: ProjectDataService

Compute orphan data.

Specified by:

computeOrphanData in interface ProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

Overrides:

computeOrphanData in class AbstractProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

getOrderEntryType

protected abstract java.lang.Class<I> getOrderEntryType()

getOrderEntryName

protected java.lang.String getOrderEntryName(IdeModifiableModelsProvider modelsProvider,
                                             I orderEntry)

removeData

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

Description copied from interface: ProjectDataService

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.

Specified by:

removeData in interface ProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

Overrides:

removeData in class AbstractProjectDataService<E extends AbstractDependencyData<?>,I extends ExportableOrderEntry>

Parameters:

toRemoveComputable - project entities to remove

project - target project

removeData

protected void removeData(java.util.Collection<? extends ExportableOrderEntry> toRemove,
                          Module module,
                          IdeModifiableModelsProvider modelsProvider)