Package com.intellij.openapi.module

Class ModuleType<T extends ModuleBuilder>

java.lang.Object

com.intellij.openapi.module.ModuleType<T>

Direct Known Subclasses:

EmptyModuleType, InternalModuleType, JavaModuleType, PythonModuleTypeBase, UnknownModuleType, WebModuleTypeBase

public abstract class ModuleType<T extends ModuleBuilder>
extends java.lang.Object

Defines a technology (language, framework, etc) to which a particular Module instance is related. Each Module belongs to some type (see get(Module)) and it can be used to provide custom UI for New Project and Project Structure dialogs, and to customize other feature of the IDE (e.g. enable some actions only for files in modules of a specific type).

Module Type concept is considered as outdated. Enabling some features only in modules of a specific type makes it harder to mix different technologies in the same source directory, and cause conflicts in configuration files when the same directory is opened in different IDEs.

If you need to show special kinds of projects in New Project wizard, register an implementation of ModuleBuilder as an extension instead. If you need to allow users to configure something related to some technology in the IDE, use projectConfigurable for project-level settings and Facet or ModuleConfigurationEditorProvider for module-level settings. If you need to make an action enabled in presence of a specific technology only, do this by looking for required files in the project directories, not by checking type of the current module.

Field Summary

Fields

Modifier and Type	Field and Description
static ModuleType<?>	EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModuleType(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
abstract T	createModuleBuilder()
ModuleWizardStep []	createWizardSteps(WizardContext wizardContext, T moduleBuilder, ModulesProvider modulesProvider)
boolean	equals(java.lang.Object o)
static ModuleType	get(Module module)
FrameworkRole	getDefaultAcceptableRole()
abstract java.lang.String	getDescription()
javax.swing.Icon	getIcon()
java.lang.String	getId()
abstract java.lang.String	getName()
abstract javax.swing.Icon	getNodeIcon(boolean isOpened)
int	hashCode()
static boolean	is(Module module, ModuleType moduleType)
static boolean	isInternal(Module module)
boolean	isMarkInnerSupportedFor(JpsModuleSourceRootType type)
boolean	isSupportedRootType(JpsModuleSourceRootType type)
boolean	isValidSdk(Module module, Sdk projectSdk)
ModuleWizardStep	modifyProjectTypeStep(SettingsStep settingsStep, ModuleBuilder moduleBuilder)
ModuleWizardStep	modifySettingsStep(SettingsStep settingsStep, ModuleBuilder moduleBuilder)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final ModuleType<?> EMPTY

Constructor Detail

ModuleType

protected ModuleType(java.lang.String id)

Method Detail

createModuleBuilder

public abstract T createModuleBuilder()

getName

public abstract java.lang.String getName()

getDescription

public abstract java.lang.String getDescription()

getIcon

public javax.swing.Icon getIcon()

getNodeIcon

public abstract javax.swing.Icon getNodeIcon(@Deprecated
                                             boolean isOpened)

createWizardSteps

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

modifySettingsStep

public ModuleWizardStep modifySettingsStep(SettingsStep settingsStep,
                                           ModuleBuilder moduleBuilder)

modifyProjectTypeStep

public ModuleWizardStep modifyProjectTypeStep(SettingsStep settingsStep,
                                              ModuleBuilder moduleBuilder)

getId

public final java.lang.String getId()

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isValidSdk

public boolean isValidSdk(Module module,
                          Sdk projectSdk)

is

public static boolean is(Module module,
                         ModuleType moduleType)

isInternal

public static boolean isInternal(Module module)

get

public static ModuleType get(Module module)

getDefaultAcceptableRole

public FrameworkRole getDefaultAcceptableRole()

isSupportedRootType

public boolean isSupportedRootType(JpsModuleSourceRootType type)

isMarkInnerSupportedFor

public boolean isMarkInnerSupportedFor(JpsModuleSourceRootType type)