Package com.intellij.execution.runners

Interface ProgramRunner<Settings extends RunnerSettings>

All Known Implementing Classes:

PythonRunner, ShRunProgramRunner

public interface ProgramRunner<Settings extends RunnerSettings>

A ProgramRunner is responsible for the execution workflow of certain types of run configurations with a certain executor. For example, one ProgramRunner can be responsible for debugging all Java-based run configurations (applications, JUnit tests, etc.); the run configuration takes care of building a command line and the program runner takes care of how exactly it needs to be executed. A newly created program runner should be registered in a corresponding plugin.xml: <extensions defaultExtensionNs="com.intellij"> <programRunner implementation="RunnerClassFQN"/> </extensions>

See Also:

AsyncProgramRunner

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProgramRunner.Callback

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ProgramRunner<? extends RunnerSettings>>	PROGRAM_RUNNER_EP

Method Summary

Modifier and Type	Method and Description
boolean	canRun(java.lang.String executorId, RunProfile profile) Checks if the program runner is capable of running the specified configuration with the specified executor.
default void	checkConfiguration(RunnerSettings settings, ConfigurationPerRunnerSettings configurationPerRunnerSettings)
default Settings	createConfigurationData(ConfigurationInfoProvider settingsProvider) Creates a block of per-configuration settings used by this program runner.
void	execute(ExecutionEnvironment environment)
default void	execute(ExecutionEnvironment environment, ProgramRunner.Callback callback) Deprecated. Use execute(ExecutionEnvironment) and ExecutionEnvironment#setCallback(Callback)
static ProgramRunner<?>	findRunnerById(java.lang.String id)
static ProgramRunner<RunnerSettings>	getRunner(java.lang.String executorId, RunProfile settings)
java.lang.String	getRunnerId() Returns the unique ID of this runner.
default SettingsEditor<Settings>	getSettingsEditor(Executor executor, RunConfiguration configuration)
default void	onProcessStarted(RunnerSettings settings, ExecutionResult executionResult) Deprecated. Not used by platform.

Field Detail

PROGRAM_RUNNER_EP

static final ExtensionPointName<ProgramRunner<? extends RunnerSettings>> PROGRAM_RUNNER_EP

Method Detail

findRunnerById

static ProgramRunner<?> findRunnerById(java.lang.String id)

getRunner

static ProgramRunner<RunnerSettings> getRunner(java.lang.String executorId,
                                               RunProfile settings)

getRunnerId

java.lang.String getRunnerId()

Returns the unique ID of this runner. This ID is used to store settings and must not change between plugin versions.

Returns:

the program runner ID.

canRun

boolean canRun(java.lang.String executorId,
               RunProfile profile)

Checks if the program runner is capable of running the specified configuration with the specified executor.

Parameters:

executorId - ID of the Executor with which the user is trying to run the configuration.

profile - the configuration being run.

Returns:

true if the runner can handle it, false otherwise.

createConfigurationData

default Settings createConfigurationData(ConfigurationInfoProvider settingsProvider)

Creates a block of per-configuration settings used by this program runner.

Parameters:

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

Returns:

the per-runner settings, or null if this runner doesn't use any per-runner settings.

checkConfiguration

default void checkConfiguration(RunnerSettings settings,
                                ConfigurationPerRunnerSettings configurationPerRunnerSettings)
                         throws RuntimeConfigurationException

Throws:

RuntimeConfigurationException

onProcessStarted

@Deprecated
default void onProcessStarted(RunnerSettings settings,
                              ExecutionResult executionResult)

Deprecated. Not used by platform.

getSettingsEditor

default SettingsEditor<Settings> getSettingsEditor(Executor executor,
                                                   RunConfiguration configuration)

execute

void execute(ExecutionEnvironment environment)
      throws ExecutionException

Throws:

ExecutionException

execute

@Deprecated
default void execute(ExecutionEnvironment environment,
                     ProgramRunner.Callback callback)
              throws ExecutionException

Deprecated. Use execute(ExecutionEnvironment) and ExecutionEnvironment#setCallback(Callback)

Throws:

ExecutionException