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

Class AbstractModuleDataService<E extends ModuleData>

java.lang.Object

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

com.intellij.openapi.externalSystem.service.project.manage.AbstractModuleDataService<E>

All Implemented Interfaces:

ProjectDataService<E,Module>

Direct Known Subclasses:

GradleSourceSetDataService, ModuleDataService

public abstract class AbstractModuleDataService<E extends ModuleData>
extends AbstractProjectDataService<E,Module>

Field Summary

Fields

Modifier and Type	Field and Description
static Key<ModuleData>	MODULE_DATA_KEY
static Key<Module>	MODULE_KEY
static Key<java.util.Map<OrderEntry,OrderAware>>	ORDERED_DATA_MAP_KEY

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

EMPTY_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractModuleDataService()

Method Summary

Modifier and Type	Method and Description
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.
void	onFailureImport(Project project)
void	onSuccessImport(java.util.Collection<DataNode<E>> imported, ProjectData projectData, Project project, IdeModelsProvider modelsProvider)
void	postProcess(java.util.Collection<DataNode<E>> toImport, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider)
protected void	rearrangeOrderEntries(java.util.Map<OrderEntry,OrderAware> orderEntryDataMap, ModifiableRootModel modifiableRootModel)
void	removeData(Computable<java.util.Collection<Module>> toRemoveComputable, java.util.Collection<DataNode<E>> toIgnore, ProjectData projectData, Project project, IdeModifiableModelsProvider modelsProvider) Asks to remove all given ide project entities.
protected void	setModuleOptions(Module module, DataNode<E> moduleDataNode)
static void	unlinkModuleFromExternalSystem(Module module)

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

computeOrphanData, getTargetDataKey

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_DATA_KEY

public static final Key<ModuleData> MODULE_DATA_KEY

MODULE_KEY

public static final Key<Module> MODULE_KEY

ORDERED_DATA_MAP_KEY

public static final Key<java.util.Map<OrderEntry,OrderAware>> ORDERED_DATA_MAP_KEY

Constructor Detail

AbstractModuleDataService

public AbstractModuleDataService()

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 ModuleData,Module>

Overrides:

importData in class AbstractProjectDataService<E extends ModuleData,Module>

removeData

public void removeData(Computable<java.util.Collection<Module>> 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 ModuleData,Module>

Overrides:

removeData in class AbstractProjectDataService<E extends ModuleData,Module>

Parameters:

toRemoveComputable - project entities to remove

project - target project

onSuccessImport

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

onFailureImport

public void onFailureImport(Project project)

unlinkModuleFromExternalSystem

public static void unlinkModuleFromExternalSystem(Module module)

setModuleOptions

protected void setModuleOptions(Module module,
                                DataNode<E> moduleDataNode)

postProcess

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

rearrangeOrderEntries

protected void rearrangeOrderEntries(java.util.Map<OrderEntry,OrderAware> orderEntryDataMap,
                                     ModifiableRootModel modifiableRootModel)