Package com.intellij.execution.actions

Class ConfigurationFromContext

java.lang.Object

com.intellij.execution.actions.ConfigurationFromContext

Direct Known Subclasses:

ConfigurationFromContextImpl, ConfigurationFromContextWrapper

public abstract class ConfigurationFromContext
extends java.lang.Object

Describes a run configuration being created by a context run action.

See Also:

RunConfigurationProducer

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<ConfigurationFromContext>	COMPARATOR Compares configurations according to precedence.
static java.util.Comparator<ConfigurationFromContext>	NAME_COMPARATOR Compares configurations according to configuration type name.

Constructor Summary

Constructors

Constructor and Description
ConfigurationFromContext()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlternativeLocationDisplayName() Return alternative location display name provided by MultipleRunLocationsProvider.
RunConfiguration	getConfiguration() Returns the run configuration object for the created configuration.
abstract RunnerAndConfigurationSettings	getConfigurationSettings() Returns the created run configuration settings.
ConfigurationType	getConfigurationType() Returns the type of the created configuration.
abstract PsiElement	getSourceElement() Returns the element from which this configuration was created.
boolean	isFromAlternativeLocation() Return if this configuration was created from alternative location provided by MultipleRunLocationsProvider.
boolean	isPreferredTo(ConfigurationFromContext other) Checks if this configuration should be discarded in favor of another configuration created from the same context.
boolean	isProducedBy(java.lang.Class<? extends RunConfigurationProducer> producerClass) Checks if this configuration was created by the specified producer.
void	onFirstRun(ConfigurationContext context, java.lang.Runnable startRunnable) Called before the configuration created from context is first executed.
void	setAlternativeLocationDisplayName(java.lang.String alternativeLocationDisplayName)
abstract void	setConfigurationSettings(RunnerAndConfigurationSettings configurationSettings)
void	setFromAlternativeLocation(boolean isFromAlternativeLocation)
boolean	shouldReplace(ConfigurationFromContext other) Checks if this configuration should replace another one, that is if the other should be discarded.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COMPARATOR

public static final java.util.Comparator<ConfigurationFromContext> COMPARATOR

Compares configurations according to precedence.

NAME_COMPARATOR

public static final java.util.Comparator<ConfigurationFromContext> NAME_COMPARATOR

Compares configurations according to configuration type name.

Constructor Detail

ConfigurationFromContext

public ConfigurationFromContext()

Method Detail

getConfigurationSettings

public abstract RunnerAndConfigurationSettings getConfigurationSettings()

Returns the created run configuration settings.

Returns:

the created run configuration settings.

setConfigurationSettings

public abstract void setConfigurationSettings(RunnerAndConfigurationSettings configurationSettings)

getConfiguration

public RunConfiguration getConfiguration()

Returns the run configuration object for the created configuration.

Returns:

the run configuration object.

getConfigurationType

public ConfigurationType getConfigurationType()

Returns the type of the created configuration.

Returns:

the configuration type.

getSourceElement

public abstract PsiElement getSourceElement()

Returns the element from which this configuration was created. Configurations created from a lower-level element (for example, a method) take precedence over configurations created from a higher-level element (for example, a class).

Returns:

the PSI element from which the configuration was created.

onFirstRun

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

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

Parameters:

context - the context

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

isPreferredTo

public boolean isPreferredTo(ConfigurationFromContext other)

Checks if this configuration should be discarded in favor of another configuration created from the same context.

Parameters:

other - another configuration created from the same context.

Returns:

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

shouldReplace

public boolean shouldReplace(ConfigurationFromContext other)

Checks if this configuration should replace another one, that is if the other should be discarded.

Returns:

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

See Also:

RunConfigurationProducer.shouldReplace(ConfigurationFromContext, ConfigurationFromContext)

isProducedBy

public boolean isProducedBy(java.lang.Class<? extends RunConfigurationProducer> producerClass)

Checks if this configuration was created by the specified producer.

Parameters:

producerClass - the run configuration producer class.

Returns:

true if the configuration was created by this producer, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isFromAlternativeLocation

public boolean isFromAlternativeLocation()

Return if this configuration was created from alternative location provided by MultipleRunLocationsProvider.

Returns:

true if the configuration was created from alternative location, false otherwise.

setFromAlternativeLocation

public void setFromAlternativeLocation(boolean isFromAlternativeLocation)

getAlternativeLocationDisplayName

public java.lang.String getAlternativeLocationDisplayName()

Return alternative location display name provided by MultipleRunLocationsProvider.

Returns:

Location display name, null if name was not provided or this configuration is not from alternative location.

setAlternativeLocationDisplayName

public void setAlternativeLocationDisplayName(java.lang.String alternativeLocationDisplayName)