Package com.intellij.execution.actions

Class RunConfigurationProducer<T extends RunConfiguration>

java.lang.Object

com.intellij.execution.actions.RunConfigurationProducer<T>

Direct Known Subclasses:

AbstractExternalSystemRunConfigurationProducer, CompatibleRunConfigurationProducer, JavaRunConfigurationProducerBase

public abstract class RunConfigurationProducer<T extends RunConfiguration>
extends java.lang.Object

Supports creating run configurations from context (by right-clicking a code element in the source editor or the project view). Typically, run configurations that can be created from context should extend the LocatableConfigurationBase class.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<RunConfigurationProducer>	EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	RunConfigurationProducer(boolean internalUsageOnly) Do NOT use directly.
protected	RunConfigurationProducer(java.lang.Class<? extends ConfigurationType> type) Deprecated. Use LazyRunConfigurationProducer.
protected	RunConfigurationProducer(ConfigurationFactory configurationFactory) Deprecated. Use LazyRunConfigurationProducer.
protected	RunConfigurationProducer(ConfigurationType configurationType) Deprecated. Use LazyRunConfigurationProducer.

Method Summary

Modifier and Type	Method and Description
protected RunnerAndConfigurationSettings	cloneTemplateConfiguration(ConfigurationContext context)
protected static RunnerAndConfigurationSettings	cloneTemplateConfigurationStatic(ConfigurationContext context, ConfigurationFactory configurationFactory)
ConfigurationFromContext	createConfigurationFromContext(ConfigurationContext context) Creates a run configuration from the context.
RunConfiguration	createLightConfiguration(ConfigurationContext context)
RunnerAndConfigurationSettings	findExistingConfiguration(ConfigurationContext context) Searches the list of existing run configurations to find one created from this context.
ConfigurationFromContext	findOrCreateConfigurationFromContext(ConfigurationContext context) Searches the list of existing run configurations to find one created from this context.
ConfigurationFactory	getConfigurationFactory()
protected java.util.List<RunnerAndConfigurationSettings>	getConfigurationSettingsList(RunManager runManager)
ConfigurationType	getConfigurationType()
static <T extends RunConfigurationProducer> T	getInstance(java.lang.Class<? extends T> aClass)
static java.util.List<RunConfigurationProducer<?>>	getProducers(Project project)
abstract boolean	isConfigurationFromContext(T configuration, ConfigurationContext context) Checks if the specified configuration was created from the specified context.
boolean	isPreferredConfiguration(ConfigurationFromContext self, ConfigurationFromContext other) When two configurations are created from the same context by two different producers, checks if the configuration created by this producer should be discarded in favor of the other one.
void	onFirstRun(ConfigurationFromContext configuration, ConfigurationContext context, java.lang.Runnable startRunnable) Called before a configuration created from context by this producer is first executed.
protected abstract boolean	setupConfigurationFromContext(T configuration, ConfigurationContext context, Ref<PsiElement> sourceElement) Sets up a configuration based on the specified context.
boolean	shouldReplace(ConfigurationFromContext self, ConfigurationFromContext other) When two configurations are created from the same context by two different producers, checks if the configuration created by this producer should replace the other one, that is if the other one should be discarded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EP_NAME

public static final ExtensionPointName<RunConfigurationProducer> EP_NAME

Constructor Detail

RunConfigurationProducer

@Deprecated
protected RunConfigurationProducer(ConfigurationFactory configurationFactory)

Deprecated. Use LazyRunConfigurationProducer.

RunConfigurationProducer

@Deprecated
protected RunConfigurationProducer(java.lang.Class<? extends ConfigurationType> type)

Deprecated. Use LazyRunConfigurationProducer.

RunConfigurationProducer

public RunConfigurationProducer(boolean internalUsageOnly)

Do NOT use directly.

RunConfigurationProducer

@Deprecated
protected RunConfigurationProducer(ConfigurationType configurationType)

Deprecated. Use LazyRunConfigurationProducer.

Method Detail

getProducers

public static java.util.List<RunConfigurationProducer<?>> getProducers(Project project)

getConfigurationFactory

public ConfigurationFactory getConfigurationFactory()

getConfigurationType

public final ConfigurationType getConfigurationType()

createConfigurationFromContext

public ConfigurationFromContext createConfigurationFromContext(ConfigurationContext context)

Creates a run configuration from the context.

Parameters:

context - contains the information about a location in the source code.

Returns:

a container with a prepared run configuration and the context element from which it was created, or null if the context is not applicable to this run configuration producer.

setupConfigurationFromContext

protected abstract boolean setupConfigurationFromContext(T configuration,
                                                         ConfigurationContext context,
                                                         Ref<PsiElement> sourceElement)

Sets up a configuration based on the specified context.

Parameters:

configuration - a clone of the template run configuration of the specified type

context - contains the information about a location in the source code.

sourceElement - a reference to the source element for the run configuration (by default contains the element at caret, can be updated by the producer to point to a higher-level element in the tree).

Returns:

true if the context is applicable to this run configuration producer, false if the context is not applicable and the configuration should be discarded.

isConfigurationFromContext

public abstract boolean isConfigurationFromContext(T configuration,
                                                   ConfigurationContext context)

Checks if the specified configuration was created from the specified context.

Parameters:

configuration - a configuration instance.

context - contains the information about a location in the source code.

Returns:

true if this configuration was created from the specified context, false otherwise.

isPreferredConfiguration

public boolean isPreferredConfiguration(ConfigurationFromContext self,
                                        ConfigurationFromContext other)

When two configurations are created from the same context by two different producers, checks if the configuration created by this producer should be discarded in favor of the other one.

Parameters:

self - a configuration created by this producer.

other - a configuration created by another producer.

Returns:

true if the configuration created by this producer is at least as good as the other one; false if this configuration should be discarded and the other one should be used instead.

See Also:

shouldReplace(ConfigurationFromContext, ConfigurationFromContext)

shouldReplace

public boolean shouldReplace(ConfigurationFromContext self,
                             ConfigurationFromContext other)

When two configurations are created from the same context by two different producers, checks if the configuration created by this producer should replace the other one, that is if the other one should be discarded.

This is the same relationship as isPreferredConfiguration(ConfigurationFromContext, ConfigurationFromContext) but specified from the "replacement" side.

Parameters:

self - a configuration created by this producer.

other - a configuration created by another producer.

Returns:

true if the other configuration should be discarded, false otherwise.

See Also:

isPreferredConfiguration(ConfigurationFromContext, ConfigurationFromContext)

onFirstRun

public void onFirstRun(ConfigurationFromContext configuration,
                       ConfigurationContext context,
                       java.lang.Runnable startRunnable)

Called before a configuration created from context by this producer is first executed. Can be used to show additional UI for customizing the created configuration.

Parameters:

configuration - a configuration created by this producer.

context - the context

startRunnable - the runnable that needs to be called after additional customization is complete.

findOrCreateConfigurationFromContext

public ConfigurationFromContext findOrCreateConfigurationFromContext(ConfigurationContext context)

Searches the list of existing run configurations to find one created from this context. Returns one if found, or tries to create a new configuration from this context if not found.

Parameters:

context - contains the information about a location in the source code.

Returns:

a configuration (new or existing) matching the context, or null if the context is not applicable to this producer.

findExistingConfiguration

public RunnerAndConfigurationSettings findExistingConfiguration(ConfigurationContext context)

Searches the list of existing run configurations to find one created from this context. Returns one if found.

Parameters:

context - contains the information about a location in the source code.

Returns:

an existing configuration matching the context, or null if no such configuration is found.

getConfigurationSettingsList

protected java.util.List<RunnerAndConfigurationSettings> getConfigurationSettingsList(RunManager runManager)

Returns:

list of configurations that may match this producer

cloneTemplateConfiguration

protected RunnerAndConfigurationSettings cloneTemplateConfiguration(ConfigurationContext context)

cloneTemplateConfigurationStatic

protected static RunnerAndConfigurationSettings cloneTemplateConfigurationStatic(ConfigurationContext context,
                                                                                 ConfigurationFactory configurationFactory)

getInstance

public static <T extends RunConfigurationProducer> T getInstance(java.lang.Class<? extends T> aClass)

createLightConfiguration

public RunConfiguration createLightConfiguration(ConfigurationContext context)