Package com.intellij.execution.configurations

Class RunConfigurationBase<T>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DeployToServerRunConfiguration, LocatableConfigurationBase

public abstract class RunConfigurationBase<T>
extends UserDataHolderBase
implements RunConfiguration, TargetAwareRunProfile, ConfigurationCreationListener

Standard base class for run configuration implementations.

Nested Class Summary

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

RunConfiguration.RestartSingletonResult

Field Summary

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

DATA_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RunConfigurationBase(Project project, ConfigurationFactory factory, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addLogFile(java.lang.String file, java.lang.String alias, boolean checked)
void	addLogFile(java.lang.String file, java.lang.String alias, boolean checked, boolean skipContent, boolean showAll)
void	addPredefinedLogFile(PredefinedLogFile predefinedLogFile)
boolean	canRunOn(ExecutionTarget target) Checks if this configuration supports running on the provided target (see ExecutionTarget for details).
void	checkRunnerSettings(ProgramRunner runner, RunnerSettings runnerSettings, ConfigurationPerRunnerSettings configurationPerRunnerSettings)
void	checkSettingsBeforeRun()
RunConfiguration	clone() Clones the run configuration.
boolean	collectOutputFromProcessHandler()
void	createAdditionalTabComponents(AdditionalTabComponentManager manager, ProcessHandler startedProcess)
void	customizeLogConsole(LogConsole console)
boolean	equals(java.lang.Object obj)
boolean	excludeCompileBeforeLaunchOption() Deprecated. Use RunProfileWithCompileBeforeLaunchOption.isExcludeCompileBeforeLaunchOption()
java.util.ArrayList<LogFileOptions>	getAllLogFiles()
java.util.List<BeforeRunTask<?>>	getBeforeRunTasks()
protected java.lang.Class<? extends RunConfigurationOptions>	getDefaultOptionsClass() Do not override this method, it is intended to support old (not migrated to options class) run configurations.
ConfigurationFactory	getFactory() Returns the factory that has created the run configuration.
javax.swing.Icon	getIcon() Returns the icon for the run configuration.
java.util.List<LogFileOptions>	getLogFiles()
java.lang.String	getName() Returns the name of the run configuration.
protected RunConfigurationOptions	getOptions()
protected java.lang.Class<? extends RunConfigurationOptions>	getOptionsClass() Do not override this method, use ConfigurationFactory.getOptionsClass().
LogFileOptions	getOptionsForPredefinedLogFile(PredefinedLogFile predefinedLogFile)
java.lang.String	getOutputFilePath()
java.util.List<PredefinedLogFile>	getPredefinedLogFiles()
Project	getProject() Returns the project in which the run configuration exists.
T	getState()
int	hashCode()
boolean	isAllowRunningInParallel()
protected boolean	isNewSerializationUsed() Deprecated. Not used anymore.
boolean	isSaveOutputToFile()
boolean	isShowConsoleOnStdErr()
boolean	isShowConsoleOnStdOut()
void	loadState(T state)
void	onConfigurationCopied()
void	onNewConfigurationCreated() Called when configuration created via UI (Add Configuration).
void	readExternal(Element element)
void	removeAllLogFiles()
void	removeAllPredefinedLogFiles()
void	setAllowRunningInParallel(boolean value)
void	setBeforeRunTasks(java.util.List<BeforeRunTask<?>> value)
void	setFileOutputPath(java.lang.String fileOutputPath)
void	setName(java.lang.String name) Sets the name of the configuration.
void	setOptionsFromConfigurationFile(BaseState state)
void	setSaveOutputToFile(boolean redirectOutput)
void	setShowConsoleOnStdErr(boolean showConsoleOnStdErr)
void	setShowConsoleOnStdOut(boolean showConsoleOnStdOut)
java.lang.String	toString()
void	writeExternal(Element element)

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.RunConfiguration

checkConfiguration, createRunnerSettings, getConfigurationEditor, getId, getPresentableType, getRunnerSettingsEditor, getType, getUniqueID, hideDisabledExecutorButtons, restartSingleton

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

getState

Constructor Detail

RunConfigurationBase

protected RunConfigurationBase(Project project,
                               ConfigurationFactory factory,
                               java.lang.String name)

Method Detail

getOptions

protected RunConfigurationOptions getOptions()

getBeforeRunTasks

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

Specified by:

getBeforeRunTasks in interface RunConfiguration

setBeforeRunTasks

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

Specified by:

setBeforeRunTasks in interface RunConfiguration

getFactory

public final ConfigurationFactory getFactory()

Description copied from interface: RunConfiguration

Returns the factory that has created the run configuration.

Specified by:

getFactory in interface RunConfiguration

setName

public final void setName(java.lang.String name)

Description copied from interface: RunConfiguration

Sets the name of the configuration.

Specified by:

setName in interface RunConfiguration

getProject

public final Project getProject()

Description copied from interface: RunConfiguration

Returns the project in which the run configuration exists.

Specified by:

getProject in interface RunConfiguration

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: RunProfile

Returns the icon for the run configuration. This icon is displayed in the tab showing the results of executing the run profile, and for persistent run configurations is also used in the run configuration management UI.

Specified by:

getIcon in interface RunProfile

Returns:

the icon for the run configuration, or null if the default executor icon should be used.

getName

public final java.lang.String getName()

Description copied from interface: RunProfile

Returns the name of the run configuration.

Specified by:

getName in interface RunProfile

Returns:

the name of the run configuration.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

checkRunnerSettings

public void checkRunnerSettings(ProgramRunner runner,
                                RunnerSettings runnerSettings,
                                ConfigurationPerRunnerSettings configurationPerRunnerSettings)
                         throws RuntimeConfigurationException

Throws:

RuntimeConfigurationException

checkSettingsBeforeRun

public void checkSettingsBeforeRun()
                            throws RuntimeConfigurationException

Throws:

RuntimeConfigurationException

canRunOn

public boolean canRunOn(ExecutionTarget target)

Description copied from interface: TargetAwareRunProfile

Checks if this configuration supports running on the provided target (see ExecutionTarget for details).

Specified by:

canRunOn in interface TargetAwareRunProfile

Parameters:

target - target provided by ExecutionTargetProvider

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public RunConfiguration clone()

Description copied from interface: RunConfiguration

Clones the run configuration.

Specified by:

clone in interface RunConfiguration

Overrides:

clone in class UserDataHolderBase

Returns:

a clone of this run configuration.

getOptionsForPredefinedLogFile

public LogFileOptions getOptionsForPredefinedLogFile(PredefinedLogFile predefinedLogFile)

removeAllPredefinedLogFiles

public void removeAllPredefinedLogFiles()

addPredefinedLogFile

public void addPredefinedLogFile(PredefinedLogFile predefinedLogFile)

getPredefinedLogFiles

public java.util.List<PredefinedLogFile> getPredefinedLogFiles()

getAllLogFiles

public java.util.ArrayList<LogFileOptions> getAllLogFiles()

getLogFiles

public java.util.List<LogFileOptions> getLogFiles()

addLogFile

public void addLogFile(java.lang.String file,
                       java.lang.String alias,
                       boolean checked)

addLogFile

public void addLogFile(java.lang.String file,
                       java.lang.String alias,
                       boolean checked,
                       boolean skipContent,
                       boolean showAll)

removeAllLogFiles

public void removeAllLogFiles()

createAdditionalTabComponents

public void createAdditionalTabComponents(AdditionalTabComponentManager manager,
                                          ProcessHandler startedProcess)

customizeLogConsole

public void customizeLogConsole(LogConsole console)

getState

public T getState()

loadState

public void loadState(T state)

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface RunConfiguration

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)

Specified by:

writeExternal in interface RunConfiguration

setOptionsFromConfigurationFile

public void setOptionsFromConfigurationFile(BaseState state)

getOptionsClass

protected java.lang.Class<? extends RunConfigurationOptions> getOptionsClass()

Do not override this method, use ConfigurationFactory.getOptionsClass().

getDefaultOptionsClass

protected java.lang.Class<? extends RunConfigurationOptions> getDefaultOptionsClass()

Do not override this method, it is intended to support old (not migrated to options class) run configurations.

isSaveOutputToFile

public boolean isSaveOutputToFile()

setSaveOutputToFile

public void setSaveOutputToFile(boolean redirectOutput)

isShowConsoleOnStdOut

public boolean isShowConsoleOnStdOut()

setShowConsoleOnStdOut

public void setShowConsoleOnStdOut(boolean showConsoleOnStdOut)

isShowConsoleOnStdErr

public boolean isShowConsoleOnStdErr()

setShowConsoleOnStdErr

public void setShowConsoleOnStdErr(boolean showConsoleOnStdErr)

getOutputFilePath

public java.lang.String getOutputFilePath()

setFileOutputPath

public void setFileOutputPath(java.lang.String fileOutputPath)

collectOutputFromProcessHandler

public boolean collectOutputFromProcessHandler()

excludeCompileBeforeLaunchOption

@Deprecated
public boolean excludeCompileBeforeLaunchOption()

Deprecated. Use RunProfileWithCompileBeforeLaunchOption.isExcludeCompileBeforeLaunchOption()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isNewSerializationUsed

@Deprecated
protected boolean isNewSerializationUsed()

Deprecated. Not used anymore.

isAllowRunningInParallel

public final boolean isAllowRunningInParallel()

Specified by:

isAllowRunningInParallel in interface RunConfiguration

setAllowRunningInParallel

public final void setAllowRunningInParallel(boolean value)

Specified by:

setAllowRunningInParallel in interface RunConfiguration

onNewConfigurationCreated

public void onNewConfigurationCreated()

Called when configuration created via UI (Add Configuration). Suitable to perform some initialization tasks (in most cases it is indicator that you do something wrong, so, please override this method with care and only if really need).

Specified by:

onNewConfigurationCreated in interface ConfigurationCreationListener

onConfigurationCopied

public void onConfigurationCopied()

Specified by:

onConfigurationCopied in interface ConfigurationCreationListener