Package com.intellij.execution.configurations

Class LocatableConfigurationBase<T>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AntRunConfiguration, ExternalSystemRunConfiguration, JarApplicationConfiguration, ModuleBasedConfiguration, RemoteDebugConfiguration, RuntimeConfiguration, RuntimeConfigurationProducer.DelegatingRuntimeConfiguration, ShRunConfiguration, XsltRunConfiguration

public abstract class LocatableConfigurationBase<T>
extends RunConfigurationBase<T>
implements LocatableConfiguration

Common base class that should be used for configurations that can be created from context by a RunConfigurationProducer}. It supports automatically generating a name for a configuration from its settings and keeping track of whether the name was changed by the user.

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	LocatableConfigurationBase(Project project, ConfigurationFactory factory)
protected	LocatableConfigurationBase(Project project, ConfigurationFactory factory, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionName() Returns the text of the context menu action to start this run configuration.
protected java.lang.Class<? extends LocatableRunConfigurationOptions>	getDefaultOptionsClass() Do not override this method, it is intended to support old (not migrated to options class) run configurations.
protected LocatableRunConfigurationOptions	getOptions()
boolean	isGeneratedName() Checks if the current name for the run configuration was automatically generated.
void	setGeneratedName() Renames the configuration to its suggested name.
void	setNameChangedByUser(boolean nameChangedByUser)

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

addLogFile, addLogFile, addPredefinedLogFile, canRunOn, checkRunnerSettings, checkSettingsBeforeRun, clone, 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, readExternal, removeAllLogFiles, removeAllPredefinedLogFiles, setAllowRunningInParallel, setBeforeRunTasks, setFileOutputPath, setName, setOptionsFromConfigurationFile, setSaveOutputToFile, setShowConsoleOnStdErr, setShowConsoleOnStdOut, toString, writeExternal

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

suggestedName

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

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

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

getIcon, getName, getState

Constructor Detail

LocatableConfigurationBase

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

LocatableConfigurationBase

protected LocatableConfigurationBase(Project project,
                                     ConfigurationFactory factory)

Method Detail

getOptions

protected LocatableRunConfigurationOptions getOptions()

Overrides:

getOptions in class RunConfigurationBase<T>

getDefaultOptionsClass

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

Description copied from class: RunConfigurationBase

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

Overrides:

getDefaultOptionsClass in class RunConfigurationBase<T>

isGeneratedName

public boolean isGeneratedName()

Description copied from interface: LocatableConfiguration

Checks if the current name for the run configuration was automatically generated.

Specified by:

isGeneratedName in interface LocatableConfiguration

Returns:

true if the name was generated by LocatableConfiguration.suggestedName(), false if it was manually entered or changed by the user.

setGeneratedName

public void setGeneratedName()

Renames the configuration to its suggested name.

setNameChangedByUser

public void setNameChangedByUser(boolean nameChangedByUser)

getActionName

public java.lang.String getActionName()

Returns the text of the context menu action to start this run configuration. This can be different from the run configuration name (for example, for a Java unit test method, the context menu shows just the name of the method, whereas the name of the run configuration includes the class name).

Returns:

the name of the action.