Package com.intellij.execution.configurations

Class ConfigurationFactory

java.lang.Object

com.intellij.execution.configurations.ConfigurationFactory

Direct Known Subclasses:

ConfigurationFactoryEx, PythonConfigurationFactoryBase

public abstract class ConfigurationFactory
extends java.lang.Object

Factory for run configuration instances.

See Also:

ConfigurationType.getConfigurationFactories()

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationFactory[]	EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationFactory(ConfigurationType type)

Method Summary

Modifier and Type	Method and Description
boolean	canConfigurationBeSingleton() Deprecated. Use RunConfigurationSingletonPolicy
void	configureBeforeRunTaskDefaults(Key<? extends BeforeRunTask> providerID, BeforeRunTask task) In this method you can configure defaults for the task, which are preferable to be used for your particular configuration type
RunConfiguration	createConfiguration(java.lang.String name, RunConfiguration template) Creates a new run configuration with the specified name by cloning the specified template.
abstract RunConfiguration	createTemplateConfiguration(Project project) Creates a new template run configuration within the context of the specified project.
RunConfiguration	createTemplateConfiguration(Project project, RunManager runManager)
javax.swing.Icon	getAddIcon() Deprecated. Use AllIcons.General.Add
javax.swing.Icon	getIcon()
javax.swing.Icon	getIcon(RunConfiguration configuration)
java.lang.String	getId() Returns the id of the run configuration that is used for serialization.
java.lang.String	getName() The name of the run configuration variant created by this factory.
java.lang.Class<? extends BaseState>	getOptionsClass()
RunConfigurationSingletonPolicy	getSingletonPolicy()
ConfigurationType	getType()
boolean	isApplicable(Project project) Override this method and return false to hide the configuration from 'New' popup in 'Edit Configurations' dialog.
boolean	isConfigurationSingletonByDefault() Deprecated. Use RunConfigurationSingletonPolicy

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final ConfigurationFactory[] EMPTY_ARRAY

Constructor Detail

ConfigurationFactory

protected ConfigurationFactory(ConfigurationType type)

Method Detail

createConfiguration

public RunConfiguration createConfiguration(java.lang.String name,
                                            RunConfiguration template)

Creates a new run configuration with the specified name by cloning the specified template.

Parameters:

name - the name for the new run configuration.

template - the template from which the run configuration is copied

Returns:

the new run configuration.

isApplicable

public boolean isApplicable(Project project)

Override this method and return false to hide the configuration from 'New' popup in 'Edit Configurations' dialog. It will be still possible to create this configuration by clicking on '42 more items' in the 'New' popup.

Returns:

true if it makes sense to create configurations of this type in project

createTemplateConfiguration

public abstract RunConfiguration createTemplateConfiguration(Project project)

Creates a new template run configuration within the context of the specified project.

Parameters:

project - the project in which the run configuration will be used

Returns:

the run configuration instance.

createTemplateConfiguration

public RunConfiguration createTemplateConfiguration(Project project,
                                                    RunManager runManager)

getId

public java.lang.String getId()

Returns the id of the run configuration that is used for serialization. For compatibility reason the default implementation calls the method getName() and this may cause problems if getName() returns localized value. So the default implementation must be overriden in all inheritors. In existing implementations you need to use the same value which is returned by getName() for compatibility but store it directly in the code instead of taking from a message bundle. For new configurations you may use any unique ID; if a new ConfigurationType has a single ConfigurationFactory, use SimpleConfigurationType instead.

getName

public java.lang.String getName()

The name of the run configuration variant created by this factory.

getAddIcon

@Deprecated
public javax.swing.Icon getAddIcon()

Deprecated. Use AllIcons.General.Add

getIcon

public javax.swing.Icon getIcon(RunConfiguration configuration)

getIcon

public javax.swing.Icon getIcon()

getType

public ConfigurationType getType()

configureBeforeRunTaskDefaults

public void configureBeforeRunTaskDefaults(Key<? extends BeforeRunTask> providerID,
                                           BeforeRunTask task)

In this method you can configure defaults for the task, which are preferable to be used for your particular configuration type

isConfigurationSingletonByDefault

@Deprecated
public boolean isConfigurationSingletonByDefault()

Deprecated. Use RunConfigurationSingletonPolicy

canConfigurationBeSingleton

@Deprecated
public boolean canConfigurationBeSingleton()

Deprecated. Use RunConfigurationSingletonPolicy

getSingletonPolicy

public RunConfigurationSingletonPolicy getSingletonPolicy()

getOptionsClass

public java.lang.Class<? extends BaseState> getOptionsClass()