Package com.intellij.openapi.externalSystem.service.execution

Class AbstractExternalSystemTaskConfigurationType

java.lang.Object

com.intellij.openapi.externalSystem.service.execution.AbstractExternalSystemTaskConfigurationType

All Implemented Interfaces:

ConfigurationType, PossiblyDumbAware

Direct Known Subclasses:

GradleExternalTaskConfigurationType

public abstract class AbstractExternalSystemTaskConfigurationType
extends java.lang.Object
implements ConfigurationType

Basic run configuration type for external system tasks.

Field Summary

Fields inherited from interface com.intellij.execution.configurations.ConfigurationType

CONFIGURATION_TYPE_EP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalSystemTaskConfigurationType(ProjectSystemId externalSystemId)

Method Summary

Modifier and Type	Method and Description
protected ExternalSystemRunConfiguration	doCreateConfiguration(ProjectSystemId externalSystemId, Project project, ConfigurationFactory factory, java.lang.String name)
static java.lang.String	generateName(Project project, ExternalSystemTaskExecutionSettings settings)
static java.lang.String	generateName(Project project, ProjectSystemId externalSystemId, java.lang.String externalProjectPath, java.util.List<java.lang.String> taskNames, java.lang.String executionName)
static java.lang.String	generateName(Project project, ProjectSystemId externalSystemId, java.lang.String externalProjectPath, java.util.List<java.lang.String> taskNames, java.lang.String executionName, java.lang.String tasksPrefix, java.lang.String tasksPostfix)
ConfigurationFactory[]	getConfigurationFactories() Returns the configuration factories used by this configuration type.
protected java.lang.String	getConfigurationFactoryId() This method must be overriden and a proper ID must be returned from it (it'll be used as a key in run configuration file).
java.lang.String	getConfigurationTypeDescription() Returns the description of the configuration type.
java.lang.String	getDisplayName() Returns the display name of the configuration type.
ProjectSystemId	getExternalSystemId()
ConfigurationFactory	getFactory()
javax.swing.Icon	getIcon() Returns the 16x16 icon used to represent the configuration type.
java.lang.String	getId() The ID of the configuration type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.execution.configurations.ConfigurationType

getHelpTopic, getTag, isManaged

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

isDumbAware

Constructor Detail

AbstractExternalSystemTaskConfigurationType

protected AbstractExternalSystemTaskConfigurationType(ProjectSystemId externalSystemId)

Method Detail

getConfigurationFactoryId

protected java.lang.String getConfigurationFactoryId()

This method must be overriden and a proper ID must be returned from it (it'll be used as a key in run configuration file).

getExternalSystemId

public ProjectSystemId getExternalSystemId()

getFactory

public ConfigurationFactory getFactory()

doCreateConfiguration

protected ExternalSystemRunConfiguration doCreateConfiguration(ProjectSystemId externalSystemId,
                                                               Project project,
                                                               ConfigurationFactory factory,
                                                               java.lang.String name)

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: ConfigurationType

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.

Specified by:

getDisplayName in interface ConfigurationType

Returns:

the display name of the configuration type.

getConfigurationTypeDescription

public java.lang.String getConfigurationTypeDescription()

Description copied from interface: ConfigurationType

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

Specified by:

getConfigurationTypeDescription in interface ConfigurationType

Returns:

the description of the configuration type.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: ConfigurationType

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

Specified by:

getIcon in interface ConfigurationType

Returns:

the icon

getId

public java.lang.String getId()

Description copied from interface: ConfigurationType

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.

Specified by:

getId in interface ConfigurationType

getConfigurationFactories

public ConfigurationFactory[] getConfigurationFactories()

Description copied from interface: ConfigurationType

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

Specified by:

getConfigurationFactories in interface ConfigurationType

Returns:

the run configuration factories.

generateName

public static java.lang.String generateName(Project project,
                                            ExternalSystemTaskExecutionSettings settings)

generateName

public static java.lang.String generateName(Project project,
                                            ProjectSystemId externalSystemId,
                                            java.lang.String externalProjectPath,
                                            java.util.List<java.lang.String> taskNames,
                                            java.lang.String executionName)

generateName

public static java.lang.String generateName(Project project,
                                            ProjectSystemId externalSystemId,
                                            java.lang.String externalProjectPath,
                                            java.util.List<java.lang.String> taskNames,
                                            java.lang.String executionName,
                                            java.lang.String tasksPrefix,
                                            java.lang.String tasksPostfix)