Package com.intellij.execution.configurations

Interface ConfigurationType

All Superinterfaces:

PossiblyDumbAware

All Known Implementing Classes:

AbstractExternalSystemTaskConfigurationType, ApplicationConfigurationType, GradleExternalTaskConfigurationType, GroovyScriptRunConfigurationType, JarApplicationConfigurationType, JUnitConfigurationType, PythonConfigurationType, PyToxConfigurationType, RestRunConfigurationType, XsltRunConfigType

public interface ConfigurationType
extends PossiblyDumbAware

The type of a run configuration.

See Also:

ConfigurationTypeBase

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ConfigurationType>	CONFIGURATION_TYPE_EP

Method Summary

Modifier and Type	Method and Description
ConfigurationFactory[]	getConfigurationFactories() Returns the configuration factories used by this configuration type.
java.lang.String	getConfigurationTypeDescription() Returns the description of the configuration type.
java.lang.String	getDisplayName() Returns the display name of the configuration type.
default java.lang.String	getHelpTopic() Returns the topic in the help file or in Web Help which is shown when help for configurations of this type is requested.
javax.swing.Icon	getIcon() Returns the 16x16 icon used to represent the configuration type.
java.lang.String	getId() The ID of the configuration type.
default java.lang.String	getTag() The name of the run configuration group in a configuration file.
default boolean	isManaged() Is configuration fully managed by RunManager.

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Field Detail

CONFIGURATION_TYPE_EP

static final ExtensionPointName<ConfigurationType> CONFIGURATION_TYPE_EP

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns the display name of the configuration type. This is used, for example, to represent the configuration type in the run configurations tree, and also as the name of the action used to create the configuration.

Returns:

the display name of the configuration type.

getConfigurationTypeDescription

java.lang.String getConfigurationTypeDescription()

Returns the description of the configuration type. You may return the same text as the display name of the configuration type.

Returns:

the description of the configuration type.

getIcon

javax.swing.Icon getIcon()

Returns the 16x16 icon used to represent the configuration type.

Returns:

the icon

getId

java.lang.String getId()

The ID of the configuration type. Should be camel-cased without dashes, underscores, spaces and quotation marks. The ID is used to store run configuration settings in a project or workspace file and must not change between plugin versions.

getTag

default java.lang.String getTag()

The name of the run configuration group in a configuration file. The same rules as for id. Useful when id cannot be changed.

getConfigurationFactories

ConfigurationFactory[] getConfigurationFactories()

Returns the configuration factories used by this configuration type. Normally each configuration type provides just a single factory. You can return multiple factories if your configurations can be created in multiple variants (for example, local and remote for an application server).

Returns:

the run configuration factories.

getHelpTopic

default java.lang.String getHelpTopic()

Returns the topic in the help file or in Web Help which is shown when help for configurations of this type is requested.

Returns:

the help topic, or null if no help is available

isManaged

default boolean isManaged()

Is configuration fully managed by RunManager.