Package com.intellij.execution.configurations

Interface LocatableConfiguration

All Superinterfaces:

java.lang.Cloneable, RunConfiguration, RunProfile

All Known Implementing Classes:

AbstractPythonLegacyTestRunConfiguration, AbstractPythonRunConfiguration, AbstractPythonTestRunConfiguration, AbstractRunConfiguration, AbstractServerPythonRunConfiguration, AntRunConfiguration, ApplicationConfiguration, DeployToServerRunConfiguration, DocutilsRunConfiguration, ExternalSystemRunConfiguration, GradleRunConfiguration, GroovyScriptRunConfiguration, JarApplicationConfiguration, JavaScratchConfiguration, JavaTestConfigurationBase, JavaTestConfigurationWithDiscoverySupport, JUnitConfiguration, LocatableConfigurationBase, ModuleBasedConfiguration, MvcRunConfiguration, PyTestRunConfiguration, PythonDocTestRunConfiguration, PythonNoseTestRunConfiguration, PythonRunConfiguration, PythonUnitTestRunConfiguration, PyToxConfiguration, RemoteConfiguration, RemoteDebugConfiguration, RestRunConfiguration, RuntimeConfiguration, RuntimeConfigurationProducer.DelegatingRuntimeConfiguration, ShRunConfiguration, SphinxRunConfiguration, XsltRunConfiguration

public interface LocatableConfiguration
extends RunConfiguration

Base interface that should be used for configurations that can be created from context (a location in a file) by implementations of RunConfigurationProducer

See Also:

LocatableConfigurationBase

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

Method Summary

Modifier and Type	Method and Description
boolean	isGeneratedName() Checks if the current name for the run configuration was automatically generated.
default 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).

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

Method Detail

isGeneratedName

boolean isGeneratedName()

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

Returns:

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

suggestedName

default 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).

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").