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

Class AbstractExternalProjectImportBuilder<C extends AbstractImportFromExternalSystemControl>

java.lang.Object

com.intellij.ide.util.projectWizard.ProjectBuilder

com.intellij.projectImport.ProjectImportBuilder<DataNode<ProjectData>>

com.intellij.openapi.externalSystem.service.project.wizard.AbstractExternalProjectImportBuilder<C>

public abstract class AbstractExternalProjectImportBuilder<C extends AbstractImportFromExternalSystemControl>
extends ProjectImportBuilder<DataNode<ProjectData>>

GoF builder for external system backed projects.

Field Summary

Fields inherited from class com.intellij.projectImport.ProjectImportBuilder

EXTENSIONS_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager, C control, ProjectSystemId externalSystemId) Deprecated. use AbstractExternalProjectImportBuilder(ProjectDataManager, NotNullFactory, ProjectSystemId)
AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager, C control, ProjectSystemId externalSystemId) Deprecated. use AbstractExternalProjectImportBuilder(ProjectDataManager, NotNullFactory, ProjectSystemId)
AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager, NotNullFactory<? extends C> controlFactory, ProjectSystemId externalSystemId)

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyExtraSettings(WizardContext context)
void	applyProjectSettings(WizardContext context) Applies external system-specific settings like project files location etc to the given context.
protected abstract void	beforeCommit(DataNode<ProjectData> dataNode, Project project)
java.util.List<Module>	commit(Project project, ModifiableModuleModel model, ModulesProvider modulesProvider, ModifiableArtifactModel artifactModel)
protected ExternalProjectRefreshCallback	createFinalImportCallback(Project project, ExternalProjectSettings projectSettings)
Project	createProject(java.lang.String name, java.lang.String path)
protected abstract void	doPrepare(WizardContext context)
void	ensureProjectIsDefined(WizardContext wizardContext) Asks current builder to ensure that target external project is defined.
protected void	finishImport(Project project, DataNode<ProjectData> externalProjectNode, boolean isFromUI, java.util.List<Module> modules, IdeModifiableModelsProvider modelsProvider, ExternalProjectSettings projectSettings)
C	getControl(Project currentProject)
protected abstract java.io.File	getExternalProjectConfigToUse(java.io.File file) Allows to adjust external project config file to use on the basis of the given value.
DataNode<ProjectData>	getExternalProjectNode()
java.util.List<DataNode<ProjectData>>	getList()
Project	getProject(WizardContext wizardContext) Allows to get Project instance to use.
boolean	isMarked(DataNode<ProjectData> element)
void	prepare(WizardContext context)
protected Sdk	resolveProjectJdk(WizardContext context)
void	setList(java.util.List<DataNode<ProjectData>> externalSystemProjects)
void	setOpenProjectSettingsAfter(boolean on)

Methods inherited from class com.intellij.projectImport.ProjectImportBuilder

commit, getCurrentProject, getFileToImport, getIcon, getName, getTitle, isUpdate, setFileToImport, setUpdate

Methods inherited from class com.intellij.ide.util.projectWizard.ProjectBuilder

cleanup, commit, isOpenProjectSettingsAfter, isSuitableSdk, isSuitableSdkType, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExternalProjectImportBuilder

@Deprecated
public AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager,
                                            C control,
                                            ProjectSystemId externalSystemId)

Deprecated. use AbstractExternalProjectImportBuilder(ProjectDataManager, NotNullFactory, ProjectSystemId)

AbstractExternalProjectImportBuilder

@Deprecated
public AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager,
                                            C control,
                                            ProjectSystemId externalSystemId)

Deprecated. use AbstractExternalProjectImportBuilder(ProjectDataManager, NotNullFactory, ProjectSystemId)

AbstractExternalProjectImportBuilder

public AbstractExternalProjectImportBuilder(ProjectDataManager projectDataManager,
                                            NotNullFactory<? extends C> controlFactory,
                                            ProjectSystemId externalSystemId)

Method Detail

getList

public java.util.List<DataNode<ProjectData>> getList()

Specified by:

getList in class ProjectImportBuilder<DataNode<ProjectData>>

isMarked

public boolean isMarked(DataNode<ProjectData> element)

Specified by:

isMarked in class ProjectImportBuilder<DataNode<ProjectData>>

setList

public void setList(java.util.List<DataNode<ProjectData>> externalSystemProjects)

Specified by:

setList in class ProjectImportBuilder<DataNode<ProjectData>>

setOpenProjectSettingsAfter

public void setOpenProjectSettingsAfter(boolean on)

Specified by:

setOpenProjectSettingsAfter in class ProjectImportBuilder<DataNode<ProjectData>>

getControl

public C getControl(Project currentProject)

prepare

public void prepare(WizardContext context)

resolveProjectJdk

protected Sdk resolveProjectJdk(WizardContext context)

doPrepare

protected abstract void doPrepare(WizardContext context)

commit

public java.util.List<Module> commit(Project project,
                                     ModifiableModuleModel model,
                                     ModulesProvider modulesProvider,
                                     ModifiableArtifactModel artifactModel)

Specified by:

commit in class ProjectImportBuilder<DataNode<ProjectData>>

finishImport

protected void finishImport(Project project,
                            DataNode<ProjectData> externalProjectNode,
                            boolean isFromUI,
                            java.util.List<Module> modules,
                            IdeModifiableModelsProvider modelsProvider,
                            ExternalProjectSettings projectSettings)

createFinalImportCallback

protected ExternalProjectRefreshCallback createFinalImportCallback(Project project,
                                                                   ExternalProjectSettings projectSettings)

beforeCommit

protected abstract void beforeCommit(DataNode<ProjectData> dataNode,
                                     Project project)

ensureProjectIsDefined

public void ensureProjectIsDefined(WizardContext wizardContext)
                            throws ConfigurationException

Asks current builder to ensure that target external project is defined.

Parameters:

wizardContext - current wizard context

Throws:

ConfigurationException - if external project is not defined and can't be constructed

getExternalProjectConfigToUse

protected abstract java.io.File getExternalProjectConfigToUse(java.io.File file)

Allows to adjust external project config file to use on the basis of the given value.

Example: a user might choose a directory which contains target config file and particular implementation expands that to a particular file under the directory.

Parameters:

file - base external project config file

Returns:

external project config file to use

getExternalProjectNode

public DataNode<ProjectData> getExternalProjectNode()

applyProjectSettings

public void applyProjectSettings(WizardContext context)

Applies external system-specific settings like project files location etc to the given context.

Parameters:

context - storage for the project/module settings.

applyExtraSettings

protected abstract void applyExtraSettings(WizardContext context)

getProject

public Project getProject(WizardContext wizardContext)

Allows to get Project instance to use. Basically, there are two alternatives - project from the current wizard context and default project.

Parameters:

wizardContext - current wizard context

Returns:

Project instance to use

createProject

public Project createProject(java.lang.String name,
                             java.lang.String path)

Overrides:

createProject in class ProjectBuilder