Package com.intellij.execution.configurations

Interface RunConfiguration

All Superinterfaces:

java.lang.Cloneable, RunProfile

All Known Subinterfaces:

DebugAwareConfiguration, DebuggableRunConfiguration, InputRedirectAware, LocatableConfiguration, ModuleRunConfiguration, PersistentAwareRunConfiguration, RunConfigurationWithRunnerSettings

All Known Implementing Classes:

AbstractPythonLegacyTestRunConfiguration, AbstractPythonRunConfiguration, AbstractPythonTestRunConfiguration, AbstractRunConfiguration, AbstractServerPythonRunConfiguration, AntRunConfiguration, ApplicationConfiguration, DeployToServerRunConfiguration, DocutilsRunConfiguration, ExternalSystemRunConfiguration, GradleRunConfiguration, GroovyScriptRunConfiguration, JarApplicationConfiguration, JavaScratchConfiguration, JavaTestConfigurationBase, JavaTestConfigurationWithDiscoverySupport, JUnitConfiguration, LocatableConfigurationBase, ModuleBasedConfiguration, MvcRunConfiguration, PyTestRunConfiguration, PythonDocTestRunConfiguration, PythonNoseTestRunConfiguration, PythonRunConfiguration, PythonUnitTestRunConfiguration, PyToxConfiguration, RemoteConfiguration, RemoteDebugConfiguration, RestRunConfiguration, RunConfigurationBase, RuntimeConfiguration, RuntimeConfigurationProducer.DelegatingRuntimeConfiguration, ShRunConfiguration, SphinxRunConfiguration, UnknownRunConfiguration, XsltRunConfiguration

public interface RunConfiguration
extends RunProfile, java.lang.Cloneable

A run configuration which can be managed by a user and displayed in the UI.

If debugger is provided by plugin, it should also implement RunConfigurationWithSuppressedDefaultDebugAction. Otherwise (in case of disabled plugin) debug action may be enabled in UI but with no reaction.

See Also:

com.intellij.execution.RunManager, RunConfigurationBase, RefactoringListenerProvider, RunConfigurationExtensionBase

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RunConfiguration.RestartSingletonResult Further actions to restart the run configuration not allowing running in parallel.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<RunConfiguration>	DATA_KEY

Method Summary

Modifier and Type	Method and Description
default void	checkConfiguration() Checks whether the run configuration settings are valid.
RunConfiguration	clone() Clones the run configuration.
default ConfigurationPerRunnerSettings	createRunnerSettings(ConfigurationInfoProvider provider) Creates a block of settings for a specific ProgramRunner.
default java.util.List<BeforeRunTask<?>>	getBeforeRunTasks()
SettingsEditor<? extends RunConfiguration>	getConfigurationEditor() Returns the UI control for editing the run configuration settings.
ConfigurationFactory	getFactory() Returns the factory that has created the run configuration.
default java.lang.String	getId() Returns the unique identifier of the run configuration.
default java.lang.String	getPresentableType()
Project	getProject() Returns the project in which the run configuration exists.
default SettingsEditor<ConfigurationPerRunnerSettings>	getRunnerSettingsEditor(ProgramRunner runner) Creates a UI control for editing the settings for a specific ProgramRunner.
default ConfigurationType	getType() Returns the type of the run configuration.
default int	getUniqueID() Returns the unique identifier of the run configuration.
default boolean	hideDisabledExecutorButtons() If this method returns true, disabled executor buttons (e.g.
default boolean	isAllowRunningInParallel()
default void	readExternal(Element element)
default RunConfiguration.RestartSingletonResult	restartSingleton(ExecutionEnvironment environment) Allows to customize handling when restart the run configuration not allowing running in parallel.
default void	setAllowRunningInParallel(boolean value)
default void	setBeforeRunTasks(java.util.List<BeforeRunTask<?>> value)
void	setName(java.lang.String name) Sets the name of the configuration.
default void	writeExternal(Element element)

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

getIcon, getName, getState

Field Detail

DATA_KEY

static final DataKey<RunConfiguration> DATA_KEY

Method Detail

getType

default ConfigurationType getType()

Returns the type of the run configuration.

getFactory

ConfigurationFactory getFactory()

Returns the factory that has created the run configuration.

setName

void setName(java.lang.String name)

Sets the name of the configuration.

getConfigurationEditor

SettingsEditor<? extends RunConfiguration> getConfigurationEditor()

Returns the UI control for editing the run configuration settings. If additional control over validation is required, the object returned from this method may also implement CheckableRunConfigurationEditor. The returned object can also implement SettingsEditorGroup if the settings it provides need to be displayed in multiple tabs.

Returns:

the settings editor component.

getProject

Project getProject()

Returns the project in which the run configuration exists.

createRunnerSettings

default ConfigurationPerRunnerSettings createRunnerSettings(ConfigurationInfoProvider provider)

Creates a block of settings for a specific ProgramRunner. Can return null if the configuration has no settings specific to a program runner.

Parameters:

provider - source of assorted information about the configuration being edited.

Returns:

the per-runner settings.

getRunnerSettingsEditor

default SettingsEditor<ConfigurationPerRunnerSettings> getRunnerSettingsEditor(ProgramRunner runner)

Creates a UI control for editing the settings for a specific ProgramRunner. Can return null if the configuration has no settings specific to a program runner.

Parameters:

runner - the runner the settings for which need to be edited.

Returns:

the editor for the per-runner settings.

clone

RunConfiguration clone()

Clones the run configuration.

Returns:

a clone of this run configuration.

getUniqueID

default int getUniqueID()

Returns the unique identifier of the run configuration. The identifier does not need to be persisted between the sessions.

Returns:

the unique ID of the configuration.

getId

default java.lang.String getId()

Returns the unique identifier of the run configuration. Return null if not applicable. Used only for non-managed RC type.

getPresentableType

default java.lang.String getPresentableType()

hideDisabledExecutorButtons

default boolean hideDisabledExecutorButtons()

If this method returns true, disabled executor buttons (e.g. Run) will be hidden when this configuration is selected. Note that this will lead to UI flickering when switching between this configuration and others for which this property is false, so you should avoid overriding this method unless you're really sure of what you're doing.

checkConfiguration

default void checkConfiguration()
                         throws RuntimeConfigurationException

Checks whether the run configuration settings are valid. Note that this check may be invoked on every change (i.e. after each character typed in an input field).

Throws:

RuntimeConfigurationException - if the configuration settings contain a non-fatal problem which the user should be warned about but the execution should still be allowed.

RuntimeConfigurationError - if the configuration settings contain a fatal problem which makes it impossible to execute the run configuration.

readExternal

default void readExternal(Element element)

writeExternal

default void writeExternal(Element element)

getBeforeRunTasks

default java.util.List<BeforeRunTask<?>> getBeforeRunTasks()

setBeforeRunTasks

default void setBeforeRunTasks(java.util.List<BeforeRunTask<?>> value)

isAllowRunningInParallel

default boolean isAllowRunningInParallel()

setAllowRunningInParallel

default void setAllowRunningInParallel(boolean value)

restartSingleton

default RunConfiguration.RestartSingletonResult restartSingleton(ExecutionEnvironment environment)

Allows to customize handling when restart the run configuration not allowing running in parallel.

Returns:

the further actions.