Package com.intellij.execution.configurations

Class ModuleBasedConfiguration<ConfigurationModule extends RunConfigurationModule,T>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.configurations.RunConfigurationBase<T>

com.intellij.execution.configurations.LocatableConfigurationBase<T>

com.intellij.execution.configurations.ModuleBasedConfiguration<ConfigurationModule,T>

All Implemented Interfaces:

ConfigurationCreationListener, LocatableConfiguration, ModuleRunConfiguration, ModuleRunProfile, RunConfiguration, RunProfile, RunProfileWithCompileBeforeLaunchOption, SearchScopeProvidingRunProfile, TargetAwareRunProfile, UserDataHolder, UserDataHolderEx, java.lang.Cloneable

Direct Known Subclasses:

AbstractRunConfiguration, ApplicationConfiguration, GroovyScriptRunConfiguration, JavaTestConfigurationBase, MvcRunConfiguration, RemoteConfiguration

public abstract class ModuleBasedConfiguration<ConfigurationModule extends RunConfigurationModule,T>
extends LocatableConfigurationBase<T>
implements java.lang.Cloneable, ModuleRunConfiguration

Base class for a configuration that is associated with a specific module. For example, Java run configurations use the selected module to determine the run classpath.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.execution.configurations.RunConfiguration

RunConfiguration.RestartSingletonResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	TO_CLONE_ELEMENT_NAME

Fields inherited from interface com.intellij.execution.configurations.RunConfiguration

DATA_KEY

Constructor Summary

Constructors

Constructor and Description
ModuleBasedConfiguration(ConfigurationModule configurationModule, ConfigurationFactory factory)
ModuleBasedConfiguration(java.lang.String name, ConfigurationModule configurationModule, ConfigurationFactory factory)

Method Summary

Modifier and Type	Method and Description
static boolean	canRestoreOriginalModule(Module originalModule, Module[] configModules)
ModuleBasedConfiguration	clone() Clones the run configuration.
protected ModuleBasedConfiguration	createInstance() Deprecated. method ConfigurationFactory.createTemplateConfiguration(com.intellij.openapi.project.Project) would be used instead to avoid wrong custom 'cloning'
java.util.Collection<Module>	getAllModules()
ConfigurationModule	getConfigurationModule()
protected java.lang.Class<? extends ModuleBasedConfigurationOptions>	getDefaultOptionsClass() Do not override this method, it is intended to support old (not migrated to options class) run configurations.
Module []	getModules()
protected ModuleBasedConfigurationOptions	getOptions()
T	getState()
abstract java.util.Collection<Module>	getValidModules()
boolean	isModuleDirMacroSupported()
void	loadState(T state)
void	onNewConfigurationCreated() Called when configuration created via UI (Add Configuration).
void	readExternal(Element element)
protected void	readModule(Element element)
void	restoreOriginalModule(Module originalModule)
void	setModule(Module module)
void	setModuleName(java.lang.String moduleName)
protected void	syncModuleName()
void	writeExternal(Element element)
protected void	writeModule(Element element) Deprecated. Not required to be called anymore.

Methods inherited from class com.intellij.execution.configurations.LocatableConfigurationBase

getActionName, isGeneratedName, setGeneratedName, setNameChangedByUser

Methods inherited from class com.intellij.execution.configurations.RunConfigurationBase

addLogFile, addLogFile, addPredefinedLogFile, canRunOn, checkRunnerSettings, checkSettingsBeforeRun, collectOutputFromProcessHandler, createAdditionalTabComponents, customizeLogConsole, equals, excludeCompileBeforeLaunchOption, getAllLogFiles, getBeforeRunTasks, getFactory, getIcon, getLogFiles, getName, getOptionsClass, getOptionsForPredefinedLogFile, getOutputFilePath, getPredefinedLogFiles, getProject, hashCode, isAllowRunningInParallel, isNewSerializationUsed, isSaveOutputToFile, isShowConsoleOnStdErr, isShowConsoleOnStdOut, onConfigurationCopied, removeAllLogFiles, removeAllPredefinedLogFiles, setAllowRunningInParallel, setBeforeRunTasks, setFileOutputPath, setName, setOptionsFromConfigurationFile, setSaveOutputToFile, setShowConsoleOnStdErr, setShowConsoleOnStdOut, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.execution.configurations.RunConfiguration

checkConfiguration, createRunnerSettings, getBeforeRunTasks, getConfigurationEditor, getFactory, getId, getPresentableType, getProject, getRunnerSettingsEditor, getType, getUniqueID, hideDisabledExecutorButtons, isAllowRunningInParallel, restartSingleton, setAllowRunningInParallel, setBeforeRunTasks, setName

Methods inherited from interface com.intellij.execution.configurations.ModuleRunProfile

getSearchScope

Methods inherited from interface com.intellij.execution.configurations.RunProfileWithCompileBeforeLaunchOption

isBuildBeforeLaunchAddedByDefault, isBuildProjectOnEmptyModuleList, isExcludeCompileBeforeLaunchOption

Methods inherited from interface com.intellij.execution.configurations.RunProfile

getIcon, getName, getState

Methods inherited from interface com.intellij.execution.configurations.LocatableConfiguration

suggestedName

Field Detail

TO_CLONE_ELEMENT_NAME

protected static final java.lang.String TO_CLONE_ELEMENT_NAME

See Also:

Constant Field Values

Constructor Detail

ModuleBasedConfiguration

public ModuleBasedConfiguration(java.lang.String name,
                                ConfigurationModule configurationModule,
                                ConfigurationFactory factory)

ModuleBasedConfiguration

public ModuleBasedConfiguration(ConfigurationModule configurationModule,
                                ConfigurationFactory factory)

Method Detail

getOptions

protected ModuleBasedConfigurationOptions getOptions()

Overrides:

getOptions in class LocatableConfigurationBase<T>

getDefaultOptionsClass

protected java.lang.Class<? extends ModuleBasedConfigurationOptions> getDefaultOptionsClass()

Description copied from class: RunConfigurationBase

Do not override this method, it is intended to support old (not migrated to options class) run configurations.

Overrides:

getDefaultOptionsClass in class LocatableConfigurationBase<T>

getValidModules

public abstract java.util.Collection<Module> getValidModules()

getConfigurationModule

public ConfigurationModule getConfigurationModule()

setModule

public void setModule(Module module)

setModuleName

public void setModuleName(java.lang.String moduleName)

readModule

protected void readModule(Element element)

writeModule

@Deprecated
protected void writeModule(Element element)

Deprecated. Not required to be called anymore.

getAllModules

public java.util.Collection<Module> getAllModules()

createInstance

@Deprecated
protected ModuleBasedConfiguration createInstance()

Deprecated. method ConfigurationFactory.createTemplateConfiguration(com.intellij.openapi.project.Project) would be used instead to avoid wrong custom 'cloning'

getState

public final T getState()

Overrides:

getState in class RunConfigurationBase<T>

loadState

public void loadState(T state)

Overrides:

loadState in class RunConfigurationBase<T>

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface RunConfiguration

Overrides:

readExternal in class RunConfigurationBase<T>

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Specified by:

writeExternal in interface RunConfiguration

Overrides:

writeExternal in class RunConfigurationBase<T>

Throws:

WriteExternalException

syncModuleName

protected final void syncModuleName()

clone

public ModuleBasedConfiguration clone()

Description copied from interface: RunConfiguration

Clones the run configuration.

Specified by:

clone in interface RunConfiguration

Overrides:

clone in class RunConfigurationBase<T>

Returns:

a clone of this run configuration.

getModules

public Module [] getModules()

Specified by:

getModules in interface RunProfileWithCompileBeforeLaunchOption

Returns:

modules to compile before run. Empty list to build project

restoreOriginalModule

public void restoreOriginalModule(Module originalModule)

canRestoreOriginalModule

public static boolean canRestoreOriginalModule(Module originalModule,
                                               Module[] configModules)

onNewConfigurationCreated

public void onNewConfigurationCreated()

Description copied from class: RunConfigurationBase

Called when configuration created via UI (Add Configuration). Suitable to perform some initialization tasks (in most cases it is indicator that you do something wrong, so, please override this method with care and only if really need).

Specified by:

onNewConfigurationCreated in interface ConfigurationCreationListener

Overrides:

onNewConfigurationCreated in class RunConfigurationBase<T>

isModuleDirMacroSupported

public boolean isModuleDirMacroSupported()