Package com.intellij.openapi.externalSystem.service.execution

Class ExternalSystemRunConfiguration

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

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

com.intellij.execution.configurations.LocatableConfigurationBase

com.intellij.openapi.externalSystem.service.execution.ExternalSystemRunConfiguration

All Implemented Interfaces:

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

Direct Known Subclasses:

GradleRunConfiguration

public class ExternalSystemRunConfiguration
extends LocatableConfigurationBase
implements SearchScopeProvidingRunProfile

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalSystemRunConfiguration.MyRunnableState Deprecated. Internal class ExternalSystemRunConfiguration.MyRunnableState was turned into fully fledged class ExternalSystemRunnableState.

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

RunConfiguration.RestartSingletonResult

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Class<? extends BuildProgressListener>>	PROGRESS_LISTENER_KEY
static Key<java.io.InputStream>	RUN_INPUT_KEY

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

DATA_KEY

Constructor Summary

Constructors

Constructor and Description
ExternalSystemRunConfiguration(ProjectSystemId externalSystemId, Project project, ConfigurationFactory factory, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
ExternalSystemRunConfiguration	clone() Clones the run configuration.
SettingsEditor<ExternalSystemRunConfiguration>	getConfigurationEditor() Returns the UI control for editing the run configuration settings.
GlobalSearchScope	getSearchScope()
ExternalSystemTaskExecutionSettings	getSettings()
RunProfileState	getState(Executor executor, ExecutionEnvironment env) Prepares for executing a specific instance of the run configuration.
void	readExternal(Element element)
java.lang.String	suggestedName() Returns the default name for the run configuration based on its settings (such as the name of class or file to run).
void	writeExternal(Element element)

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

getActionName, getDefaultOptionsClass, getOptions, 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, getState, hashCode, isAllowRunningInParallel, isNewSerializationUsed, isSaveOutputToFile, isShowConsoleOnStdErr, isShowConsoleOnStdOut, loadState, onConfigurationCopied, onNewConfigurationCreated, 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.RunProfile

getIcon, getName

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

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

Field Detail

RUN_INPUT_KEY

public static final Key<java.io.InputStream> RUN_INPUT_KEY

PROGRESS_LISTENER_KEY

public static final Key<java.lang.Class<? extends BuildProgressListener>> PROGRESS_LISTENER_KEY

Constructor Detail

ExternalSystemRunConfiguration

public ExternalSystemRunConfiguration(ProjectSystemId externalSystemId,
                                      Project project,
                                      ConfigurationFactory factory,
                                      java.lang.String name)

Method Detail

suggestedName

public java.lang.String suggestedName()

Description copied from interface: LocatableConfiguration

Returns the default name for the run configuration based on its settings (such as the name of class or file to run).

Specified by:

suggestedName in interface LocatableConfiguration

Returns:

the suggested name for the configuration, or null if no name could be suggested based on the current settings (for example, the name of the file to run isn't yet specified). NOTE: Please don't return hard-coded strings which are not based on the current run configuration settings (such as "Unnamed").

clone

public ExternalSystemRunConfiguration clone()

Description copied from interface: RunConfiguration

Clones the run configuration.

Specified by:

clone in interface RunConfiguration

Overrides:

clone in class RunConfigurationBase

Returns:

a clone of this run configuration.

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface RunConfiguration

Overrides:

readExternal in class RunConfigurationBase

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Specified by:

writeExternal in interface RunConfiguration

Overrides:

writeExternal in class RunConfigurationBase

Throws:

WriteExternalException

getSettings

public ExternalSystemTaskExecutionSettings getSettings()

getConfigurationEditor

public SettingsEditor<ExternalSystemRunConfiguration> getConfigurationEditor()

Description copied from interface: RunConfiguration

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.

Specified by:

getConfigurationEditor in interface RunConfiguration

Returns:

the settings editor component.

getState

public RunProfileState getState(Executor executor,
                                ExecutionEnvironment env)

Description copied from interface: RunProfile

Prepares for executing a specific instance of the run configuration.

Specified by:

getState in interface RunProfile

Parameters:

executor - the execution mode selected by the user (run, debug, profile etc.)

env - the environment object containing additional settings for executing the configuration.

Returns:

the RunProfileState describing the process which is about to be started, or null if it's impossible to start the process.

getSearchScope

public GlobalSearchScope getSearchScope()

Specified by:

getSearchScope in interface SearchScopeProvidingRunProfile

Returns:

scope where to search sources for this configuration