Package com.intellij.execution.configuration

Class RunConfigurationExtensionBase<T extends RunConfigurationBase<?>>

java.lang.Object

com.intellij.execution.configuration.RunConfigurationExtensionBase<T>

Direct Known Subclasses:

DeployToServerRunConfigurationExtension, PythonRunConfigurationExtension, RunConfigurationExtension

public abstract class RunConfigurationExtensionBase<T extends RunConfigurationBase<?>>
extends java.lang.Object

Allows a plugin to extend a run configuration created by another plugin.

Constructor Summary

Constructors

Constructor and Description
RunConfigurationExtensionBase()

Method Summary

Modifier and Type	Method and Description
protected void	attachToProcess(T configuration, ProcessHandler handler, RunnerSettings runnerSettings) Attaches the extension to a process that has been started.
protected <P extends T> SettingsEditor<P>	createEditor(P configuration) Creates an editor for the settings of this extension.
protected void	extendCreatedConfiguration(T configuration, Location location) Setup extension settings for a run configuration that has been created from context.
protected void	extendTemplateConfiguration(T configuration)
protected java.lang.String	getEditorTitle() Returns the title of the tab in which the settings editor is displayed.
protected java.lang.String	getSerializationId() Returns the ID used to serialize the settings.
abstract boolean	isApplicableFor(T configuration)
abstract boolean	isEnabledFor(T applicableConfiguration, RunnerSettings runnerSettings)
protected abstract void	patchCommandLine(T configuration, RunnerSettings runnerSettings, GeneralCommandLine cmdLine, java.lang.String runnerId) Patches the command line of the process about to be started by the underlying run configuration.
protected void	patchCommandLine(T configuration, RunnerSettings runnerSettings, GeneralCommandLine cmdLine, java.lang.String runnerId, Executor executor) Patches the command line of the process about to be started by the underlying run configuration.
protected void	readExternal(T runConfiguration, Element element) Loads the settings of this extension from the run configuration XML element.
protected void	validateConfiguration(T configuration, boolean isExecution) Validate extensions after general configuration validation passed
protected void	writeExternal(T runConfiguration, Element element) Saves the settings of this extension to the run configuration XML element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunConfigurationExtensionBase

public RunConfigurationExtensionBase()

Method Detail

getSerializationId

protected java.lang.String getSerializationId()

Returns the ID used to serialize the settings.

Returns:

the serialization ID (must be unique across all run configuration extensions).

readExternal

protected void readExternal(T runConfiguration,
                            Element element)

Loads the settings of this extension from the run configuration XML element. In memory, the settings can be placed into the user data of the run configuration.

Parameters:

runConfiguration - the run configuration being deserialized.

element - the element with persisted settings.

writeExternal

protected void writeExternal(T runConfiguration,
                             Element element)

Saves the settings of this extension to the run configuration XML element.

Parameters:

runConfiguration - the run configuration being serialized.

element - the element into which the settings should be persisted,

createEditor

protected <P extends T> SettingsEditor<P> createEditor(P configuration)

Creates an editor for the settings of this extension. The editor is displayed as an additional tab of the run configuration options in the Run/Debug Configurations dialog.

Parameters:

configuration - the configuration being edited.

Returns:

the editor component, or null if this extension doesn't provide any UI for editing the settings.

getEditorTitle

protected java.lang.String getEditorTitle()

Returns the title of the tab in which the settings editor is displayed.

Returns:

the editor tab title, or null if this extension doesn't provide any UI for editing the settings.

isApplicableFor

public abstract boolean isApplicableFor(T configuration)

Parameters:

configuration - Run configuration

Returns:

True if extension in general applicable to given run configuration - just to attach settings tab, etc. But extension may be turned off in its settings. E.g. RCov in general available for given run configuration, but may be turned off.

isEnabledFor

public abstract boolean isEnabledFor(T applicableConfiguration,
                                     RunnerSettings runnerSettings)

Parameters:

applicableConfiguration - Applicable run configuration

Returns:

True if extension is turned on in configuration extension settings. E.g. RCov is turned on for given run configuration.

patchCommandLine

protected abstract void patchCommandLine(T configuration,
                                         RunnerSettings runnerSettings,
                                         GeneralCommandLine cmdLine,
                                         java.lang.String runnerId)
                                  throws ExecutionException

Patches the command line of the process about to be started by the underlying run configuration.

Parameters:

configuration - the underlying run configuration.

runnerSettings - the runner-specific settings.

cmdLine - the command line of the process about to be started.

runnerId - the ID of the ProgramRunner used to start the process.

Throws:

ExecutionException - if there was an error configuring the command line and the execution should be canceled.

patchCommandLine

protected void patchCommandLine(T configuration,
                                RunnerSettings runnerSettings,
                                GeneralCommandLine cmdLine,
                                java.lang.String runnerId,
                                Executor executor)
                         throws ExecutionException

Patches the command line of the process about to be started by the underlying run configuration.

Parameters:

configuration - the underlying run configuration.

runnerSettings - the runner-specific settings.

cmdLine - the command line of the process about to be started.

runnerId - the ID of the ProgramRunner used to start the process.

executor - the executor which is using to run the configuration

Throws:

ExecutionException - if there was an error configuring the command line and the execution should be canceled.

attachToProcess

protected void attachToProcess(T configuration,
                               ProcessHandler handler,
                               RunnerSettings runnerSettings)

Attaches the extension to a process that has been started.

Parameters:

configuration - the underlying run configuration.

handler - the ProcessHandler for the running process.

runnerSettings - the runner-specific settings.

validateConfiguration

protected void validateConfiguration(T configuration,
                                     boolean isExecution)
                              throws java.lang.Exception

Validate extensions after general configuration validation passed

Parameters:

isExecution - true if the configuration is about to be executed, false if the configuration settings are being edited.

Throws:

java.lang.Exception

extendCreatedConfiguration

protected void extendCreatedConfiguration(T configuration,
                                          Location location)

Setup extension settings for a run configuration that has been created from context.

Parameters:

configuration - Configuration created from context.

location - the location from which the configuration was created.

extendTemplateConfiguration

protected void extendTemplateConfiguration(T configuration)