Package com.intellij.execution.configurations

Interface RunProfile

All Known Subinterfaces:

CompatibilityAwareRunProfile, DebugAwareConfiguration, DebuggableRunConfiguration, InputRedirectAware, LocatableConfiguration, ModuleRunConfiguration, ModuleRunProfile, PersistentAwareRunConfiguration, RemoteRunProfile, RunConfiguration, RunConfigurationWithRunnerSettings, RunProfileWithCompileBeforeLaunchOption, SearchScopeProvidingRunProfile, TargetAwareRunProfile, TargetEnvironmentAwareRunProfile

All Known Implementing Classes:

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

public interface RunProfile

Base interface for things that can be executed (run configurations explicitly managed by user, or custom run profile implementations created from code).

See Also:

RunConfiguration, ConfigurationFactory.createTemplateConfiguration(com.intellij.openapi.project.Project)

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getIcon() Returns the icon for the run configuration.
java.lang.String	getName() Returns the name of the run configuration.
RunProfileState	getState(Executor executor, ExecutionEnvironment environment) Prepares for executing a specific instance of the run configuration.

Method Detail

getState

RunProfileState getState(Executor executor,
                         ExecutionEnvironment environment)
                  throws ExecutionException

Prepares for executing a specific instance of the run configuration.

Parameters:

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

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

Throws:

ExecutionException

getName

java.lang.String getName()

Returns the name of the run configuration.

Returns:

the name of the run configuration.

getIcon

javax.swing.Icon getIcon()

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.

Returns:

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