public interface RunConfiguration extends RunProfile, java.lang.Cloneable
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.
com.intellij.execution.RunManager
,
RunConfigurationBase
,
RefactoringListenerProvider
,
RunConfigurationExtensionBase
Modifier and Type | Interface and Description |
---|---|
static class |
RunConfiguration.RestartSingletonResult
Further actions to restart the run configuration not allowing running in parallel.
|
Modifier and Type | Field and Description |
---|---|
static DataKey<RunConfiguration> |
DATA_KEY |
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) |
getIcon, getName, getState
static final DataKey<RunConfiguration> DATA_KEY
default ConfigurationType getType()
ConfigurationFactory getFactory()
void setName(java.lang.String name)
SettingsEditor<? extends RunConfiguration> getConfigurationEditor()
CheckableRunConfigurationEditor
. The returned object
can also implement SettingsEditorGroup
if the settings it provides need to be displayed in
multiple tabs.Project getProject()
default ConfigurationPerRunnerSettings createRunnerSettings(ConfigurationInfoProvider provider)
ProgramRunner
. Can return null if the configuration has no settings specific
to a program runner.provider
- source of assorted information about the configuration being edited.default SettingsEditor<ConfigurationPerRunnerSettings> getRunnerSettingsEditor(ProgramRunner runner)
ProgramRunner
. Can return null if the configuration has no
settings specific to a program runner.runner
- the runner the settings for which need to be edited.RunConfiguration clone()
default int getUniqueID()
default java.lang.String getId()
default java.lang.String getPresentableType()
default boolean hideDisabledExecutorButtons()
default void checkConfiguration() throws RuntimeConfigurationException
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.default void readExternal(Element element)
default void writeExternal(Element element)
default java.util.List<BeforeRunTask<?>> getBeforeRunTasks()
default void setBeforeRunTasks(java.util.List<BeforeRunTask<?>> value)
default boolean isAllowRunningInParallel()
default void setAllowRunningInParallel(boolean value)
default RunConfiguration.RestartSingletonResult restartSingleton(ExecutionEnvironment environment)