Package com.intellij.ide.util.projectWizard

Class ModuleBuilder

java.lang.Object

com.intellij.ide.util.projectWizard.ProjectBuilder

com.intellij.ide.util.projectWizard.AbstractModuleBuilder

com.intellij.ide.util.projectWizard.ModuleBuilder

Direct Known Subclasses:

AbstractExternalModuleBuilder, EmptyModuleBuilder, ExistingModuleLoader, JavaModuleBuilder, PythonModuleBuilderBase, TemplateModuleBuilder, WebModuleBuilder

public abstract class ModuleBuilder
extends AbstractModuleBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleBuilder.ModuleConfigurationUpdater

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ModuleBuilderFactory>	EP_NAME
protected Sdk	myJdk

Constructor Summary

Constructors

Constructor and Description
ModuleBuilder()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	acceptParameter(java.lang.String param)
void	addListener(ModuleBuilderListener listener)
void	addModuleConfigurationUpdater(ModuleBuilder.ModuleConfigurationUpdater updater)
boolean	canCreateModule()
java.util.List<Module>	commit(Project project, ModifiableModuleModel model, ModulesProvider modulesProvider)
Module	commitModule(Project project, ModifiableModuleModel model)
Module	createAndCommitIfNeeded(Project project, ModifiableModuleModel model, boolean runFromProjectWizard)
Module	createModule(ModifiableModuleModel moduleModel)
ModuleWizardStep[]	createWizardSteps(WizardContext wizardContext, ModulesProvider modulesProvider)
static void	deleteModuleFile(java.lang.String moduleFilePath)
protected ContentEntry	doAddContentEntry(ModifiableRootModel modifiableRootModel)
protected java.util.List<WizardInputField<?>>	getAdditionalFields()
static java.util.List<ModuleBuilder>	getAllBuilders()
java.lang.String	getBuilderId()
java.lang.String	getContentEntryPath()
FrameworkRole	getDefaultAcceptableRole()
java.lang.String	getDescription()
java.lang.String	getGroupName()
java.util.List<java.lang.Class<? extends ModuleWizardStep>>	getIgnoredSteps()
java.lang.String	getModuleFileDirectory()
java.lang.String	getModuleFilePath()
Sdk	getModuleJdk()
abstract ModuleType<?>	getModuleType()
protected java.lang.String	getModuleTypeName()
java.lang.String	getName()
javax.swing.Icon	getNodeIcon()
java.lang.String	getParentGroup()
java.lang.String	getPresentableName()
protected ProjectType	getProjectType()
int	getWeight()
protected boolean	isAvailable()
boolean	isTemplate()
boolean	isTemplateBased()
ModuleWizardStep	modifyProjectTypeStep(SettingsStep settingsStep)
ModuleWizardStep	modifySettingsStep(SettingsStep settingsStep) Typically delegates to ModuleType (e.g.
ModuleWizardStep	modifyStep(SettingsStep settingsStep)
void	removeListener(ModuleBuilderListener listener)
void	setContentEntryPath(java.lang.String moduleRootPath)
void	setModuleFilePath(java.lang.String path)
void	setModuleJdk(Sdk jdk)
void	setName(java.lang.String name)
protected void	setProjectType(Module module)
protected void	setupModule(Module module)
void	setupRootModel(ModifiableRootModel modifiableRootModel)
void	updateFrom(ModuleBuilder from)

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

createFinishingSteps, equals, getCustomOptionsStep, validateModuleName

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

cleanup, commit, createProject, isOpenProjectSettingsAfter, isSuitableSdk, isSuitableSdkType, isUpdate, validate

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<ModuleBuilderFactory> EP_NAME

myJdk

protected Sdk myJdk

Constructor Detail

ModuleBuilder

public ModuleBuilder()

Method Detail

getIgnoredSteps

public java.util.List<java.lang.Class<? extends ModuleWizardStep>> getIgnoredSteps()

getAllBuilders

public static java.util.List<ModuleBuilder> getAllBuilders()

deleteModuleFile

public static void deleteModuleFile(java.lang.String moduleFilePath)

isAvailable

protected boolean isAvailable()

acceptParameter

protected static java.lang.String acceptParameter(java.lang.String param)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Specified by:

setName in class AbstractModuleBuilder

getBuilderId

public java.lang.String getBuilderId()

Specified by:

getBuilderId in class AbstractModuleBuilder

createWizardSteps

public ModuleWizardStep[] createWizardSteps(WizardContext wizardContext,
                                            ModulesProvider modulesProvider)

Specified by:

createWizardSteps in class AbstractModuleBuilder

modifySettingsStep

public ModuleWizardStep modifySettingsStep(SettingsStep settingsStep)

Typically delegates to ModuleType (e.g. JavaModuleType) that is more generic than ModuleBuilder

Overrides:

modifySettingsStep in class AbstractModuleBuilder

Parameters:

settingsStep - step to be modified

Returns:

callback (ModuleWizardStep.validate() and ModuleWizardStep.updateDataModel() will be invoked)

modifyStep

public ModuleWizardStep modifyStep(SettingsStep settingsStep)

modifyProjectTypeStep

public ModuleWizardStep modifyProjectTypeStep(SettingsStep settingsStep)

Overrides:

modifyProjectTypeStep in class AbstractModuleBuilder

getAdditionalFields

protected java.util.List<WizardInputField<?>> getAdditionalFields()

getModuleFilePath

public java.lang.String getModuleFilePath()

setModuleFilePath

public void setModuleFilePath(java.lang.String path)

Specified by:

setModuleFilePath in class AbstractModuleBuilder

addModuleConfigurationUpdater

public void addModuleConfigurationUpdater(ModuleBuilder.ModuleConfigurationUpdater updater)

getContentEntryPath

public java.lang.String getContentEntryPath()

setContentEntryPath

public void setContentEntryPath(java.lang.String moduleRootPath)

Specified by:

setContentEntryPath in class AbstractModuleBuilder

doAddContentEntry

protected ContentEntry doAddContentEntry(ModifiableRootModel modifiableRootModel)

getModuleFileDirectory

public java.lang.String getModuleFileDirectory()

createModule

public Module createModule(ModifiableModuleModel moduleModel)
                    throws InvalidDataException,
                           java.io.IOException,
                           ModuleWithNameAlreadyExists,
                           JDOMException,
                           ConfigurationException

Throws:

InvalidDataException

java.io.IOException

ModuleWithNameAlreadyExists

JDOMException

ConfigurationException

setupModule

protected void setupModule(Module module)
                    throws ConfigurationException

Throws:

ConfigurationException

setupRootModel

public void setupRootModel(ModifiableRootModel modifiableRootModel)
                    throws ConfigurationException

Throws:

ConfigurationException

getModuleType

public abstract ModuleType<?> getModuleType()

getProjectType

protected ProjectType getProjectType()

setProjectType

protected void setProjectType(Module module)

createAndCommitIfNeeded

public Module createAndCommitIfNeeded(Project project,
                                      ModifiableModuleModel model,
                                      boolean runFromProjectWizard)
                               throws InvalidDataException,
                                      ConfigurationException,
                                      java.io.IOException,
                                      JDOMException,
                                      ModuleWithNameAlreadyExists

Throws:

InvalidDataException

ConfigurationException

java.io.IOException

JDOMException

ModuleWithNameAlreadyExists

addListener

public void addListener(ModuleBuilderListener listener)

removeListener

public void removeListener(ModuleBuilderListener listener)

canCreateModule

public boolean canCreateModule()

commit

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

Specified by:

commit in class ProjectBuilder

commitModule

public Module commitModule(Project project,
                           ModifiableModuleModel model)

getNodeIcon

public javax.swing.Icon getNodeIcon()

Specified by:

getNodeIcon in class AbstractModuleBuilder

getDescription

public java.lang.String getDescription()

getPresentableName

public java.lang.String getPresentableName()

getModuleTypeName

protected java.lang.String getModuleTypeName()

getGroupName

public java.lang.String getGroupName()

getParentGroup

public java.lang.String getParentGroup()

getWeight

public int getWeight()

isTemplate

public boolean isTemplate()

isTemplateBased

public boolean isTemplateBased()

updateFrom

public void updateFrom(ModuleBuilder from)

getModuleJdk

public Sdk getModuleJdk()

setModuleJdk

public void setModuleJdk(Sdk jdk)

getDefaultAcceptableRole

public FrameworkRole getDefaultAcceptableRole()