RunnerAndConfigurationSettings (Unofficial IntelliJ Community Edition API docs)

```
public interface RunnerAndConfigurationSettings
```
Describes a complete persisted run configuration (as displayed in the Run/Debug Configurations dialog), together with runner-specific settings.

See Also:

RunManager#createConfiguration(String, ConfigurationFactory)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`canRunOn(ExecutionTarget target)` Deprecated. use `ExecutionTargetManager.canRun(RunnerAndConfigurationSettings, ExecutionTarget)` instead
`default void`	`checkSettings()` Checks whether the run configuration settings are valid.
`void`	`checkSettings(Executor executor)` Checks whether the run configuration settings are valid for execution with the specified executor.
`Factory<RunnerAndConfigurationSettings>`	`createFactory()` Returns a factory object which can be used to create a copy of this configuration.
`RunConfiguration`	`getConfiguration()` Returns the `RunConfiguration` instance that will be used to execute this run configuration.
`ConfigurationPerRunnerSettings`	`getConfigurationSettings(ProgramRunner runner)` Returns the configuration-managed settings for the specified runner.
`ConfigurationFactory`	`getFactory()` Returns the factory used to create the run configuration.
`java.lang.String`	`getFolderName()` Returns the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
`java.lang.String`	`getName()` Returns the name of the configuration.
`java.lang.String`	`getPathIfStoredInArbitraryFileInProject()`
`<Settings extends RunnerSettings> Settings`	`getRunnerSettings(ProgramRunner<Settings> runner)` Returns the runner-managed settings for the specified runner.
`ConfigurationType`	`getType()` Returns the type of the run configuration.
`java.lang.String`	`getUniqueID()`
`boolean`	`isActivateToolWindowBeforeRun()` Returns the "Before launch: Activate tool window" flag (for activation tool window Run/Debug etc.)
`boolean`	`isEditBeforeRun()` Returns the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
`default boolean`	`isShared()` Checks whether this run configuration is stored in a file (therefore, could be shared through VCS).
`default boolean`	`isSingleton()` Deprecated. Use `RunConfiguration.isAllowRunningInParallel()`
`boolean`	`isStoredInArbitraryFileInProject()` Checks if this run configuration is stored in a `.run.xml` file within the project content.
`boolean`	`isStoredInDotIdeaFolder()` Checks if this run configuration is stored as an `.xml` file in `.idea/runConfigurations` folder (or `project.ipr` file).
`boolean`	`isStoredInLocalWorkspace()` Checks if this run configuration is not shared through VCS, i.e.
`boolean`	`isTemplate()` Returns true if this configuration settings object represents a template used to create other configurations of the same type (in other words, an item under the "Defaults" node of the Run/Debug Configurations dialog).
`boolean`	`isTemporary()` Returns true if this configuration is temporary and will be deleted when the temporary configurations limit is exceeded.
`void`	`setActivateToolWindowBeforeRun(boolean value)` Sets the "Before launch: Activate tool window" flag (for activation tool window Run/Debug etc.)
`void`	`setEditBeforeRun(boolean b)` Sets the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
`void`	`setFolderName(java.lang.String folderName)` Sets the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
`void`	`setName(java.lang.String name)` Sets the name of the configuration.
`default void`	`setShared(boolean value)` Deprecated. There are different ways of storing run configuration in a file, use `storeInLocalWorkspace()`, `storeInDotIdeaFolder()` or `storeInArbitraryFileInProject(String)`
`default void`	`setSingleton(boolean value)` Deprecated. Use `RunConfiguration.setAllowRunningInParallel(boolean)`}
`void`	`setTemporary(boolean temporary)` Marks the configuration as temporary or permanent.
`void`	`storeInArbitraryFileInProject(java.lang.String filePath)` Make this run configuration possible to share through VCS: store it in a `.run.xml` file anywhere within the project content.
`void`	`storeInDotIdeaFolder()` Make this run configuration possible to share through VCS: store it as an `.xml` file in `.idea/runConfigurations` folder (or `project.ipr` file).
`void`	`storeInLocalWorkspace()` Make this run configuration impossible to share through VCS, store it in `.idea/workspace.xml` file.

- Method Detail
  - getType
```
ConfigurationType getType()
```
    Returns the type of the run configuration.
  - getFactory
```
ConfigurationFactory getFactory()
```
    Returns the factory used to create the run configuration.
    
    Returns:
    
    the factory
  - isTemplate
```
boolean isTemplate()
```
    Returns true if this configuration settings object represents a template used to create other configurations of the same type (in other words, an item under the "Defaults" node of the Run/Debug Configurations dialog).
    
    Returns:
    
    true if the configuration is a template, false otherwise.
  - isTemporary
```
boolean isTemporary()
```
    Returns true if this configuration is temporary and will be deleted when the temporary configurations limit is exceeded.
    
    Returns:
    
    true if the configuration is temporary, false otherwise.
  - isShared
```
default boolean isShared()
```
    Checks whether this run configuration is stored in a file (therefore, could be shared through VCS). Note that there are 2 different ways of storing run configuration in a file: .xml file in .idea/runConfigurations folder (or project.ipr file) and arbitrary .run.xml file anywhere within the project content. Effectively, this method is equivalent to isStoredInDotIdeaFolder() || isStoredInArbitraryFileInProject()
    
    See Also:
    
    isStoredInLocalWorkspace(), isStoredInDotIdeaFolder(), isStoredInArbitraryFileInProject()
  - setShared
```
@Deprecated
default void setShared(boolean value)
```
    Deprecated. There are different ways of storing run configuration in a file, use storeInLocalWorkspace(), storeInDotIdeaFolder() or storeInArbitraryFileInProject(String)
  - storeInLocalWorkspace
```
void storeInLocalWorkspace()
```
    Make this run configuration impossible to share through VCS, store it in .idea/workspace.xml file.
    
    See Also:
    
    storeInDotIdeaFolder(), storeInArbitraryFileInProject(String)
  - isStoredInLocalWorkspace
```
boolean isStoredInLocalWorkspace()
```
    Checks if this run configuration is not shared through VCS, i.e. stored it in .idea/workspace.xml file.
    
    See Also:
    
    isStoredInDotIdeaFolder(), isStoredInArbitraryFileInProject()
  - storeInDotIdeaFolder
```
void storeInDotIdeaFolder()
```
    Make this run configuration possible to share through VCS: store it as an .xml file in .idea/runConfigurations folder (or project.ipr file). Note that there are 2 different ways of storing run configuration in a file: .xml file in .idea/runConfigurations folder (or project.ipr file) and arbitrary .run.xml file anywhere within the project content.
    
    See Also:
    
    storeInArbitraryFileInProject(String), storeInLocalWorkspace()
  - isStoredInDotIdeaFolder
```
boolean isStoredInDotIdeaFolder()
```
    Checks if this run configuration is stored as an .xml file in .idea/runConfigurations folder (or project.ipr file). Note that there are 2 different ways of storing run configuration in a file: .xml file in .idea/runConfigurations folder (or project.ipr file) and arbitrary .run.xml file anywhere within the project content.
    
    See Also:
    
    isStoredInArbitraryFileInProject(), isStoredInLocalWorkspace()
  - storeInArbitraryFileInProject
```
void storeInArbitraryFileInProject(java.lang.String filePath)
```
    Make this run configuration possible to share through VCS: store it in a .run.xml file anywhere within the project content. It's possible to store more than one run configuration in one .run.xml file. Note that there are 2 different ways of storing run configuration in a file: .xml file in .idea/runConfigurations folder (or project.ipr file) and arbitrary .run.xml file anywhere within the project content.
    
    Parameters:
    
    filePath - needs to be within the project content, otherwise the run configuration will be removed from the model.
    
    See Also:
    
    storeInDotIdeaFolder(), storeInLocalWorkspace()
  - isStoredInArbitraryFileInProject
```
boolean isStoredInArbitraryFileInProject()
```
    Checks if this run configuration is stored in a .run.xml file within the project content. Note that there are 2 different ways of storing run configuration in a file: .xml file in .idea/runConfigurations folder (or project.ipr file) and arbitrary .run.xml file anywhere within the project content.
    
    See Also:
    
    isStoredInDotIdeaFolder(), isStoredInLocalWorkspace()
  - getPathIfStoredInArbitraryFileInProject
```
java.lang.String getPathIfStoredInArbitraryFileInProject()
```
    Returns:
    
    full path of the .run.xml file if isStoredInArbitraryFileInProject() is true, null otherwise.
  - setTemporary
```
void setTemporary(boolean temporary)
```
    Marks the configuration as temporary or permanent.
    
    Parameters:
    
    temporary - true if the configuration is temporary, false if it's permanent.
  - getConfiguration
```
RunConfiguration getConfiguration()
```
    Returns the RunConfiguration instance that will be used to execute this run configuration.
  - setName
```
void setName(java.lang.String name)
```
    Sets the name of the configuration.
    
    Parameters:
    
    name - the name of the configuration
  - getName
```
java.lang.String getName()
```
    Returns the name of the configuration.
    
    Returns:
    
    the name of the configuration.
  - getUniqueID
```
java.lang.String getUniqueID()
```
  - getRunnerSettings
```
<Settings extends RunnerSettings> Settings getRunnerSettings(ProgramRunner<Settings> runner)
```
    Returns the runner-managed settings for the specified runner.
    
    Parameters:
    
    runner - the runner for which the settings are requested.
    
    Returns:
    
    the settings, or null if the runner doesn't provide any settings or the settings aren't configured for this configuration.
  - getConfigurationSettings
```
ConfigurationPerRunnerSettings getConfigurationSettings(ProgramRunner runner)
```
    Returns the configuration-managed settings for the specified runner.
    
    Parameters:
    
    runner - the runner for which the settings are requested.
    
    Returns:
    
    the settings, or null if the configuration doesn't provide any settings specific to this runner or the settings aren't configured for this configuration.
  - checkSettings
```
default void checkSettings()
                    throws RuntimeConfigurationException
```
    Checks whether the run configuration settings are valid.
    
    Throws:
    
    RuntimeConfigurationException - if the configuration settings contain a non-fatal problem which the user should be warned about but the execution should still be allowed
    
    RuntimeConfigurationError - if the configuration settings contain a fatal problem which makes it impossible to execute the run configuration.
  - checkSettings
```
void checkSettings(Executor executor)
            throws RuntimeConfigurationException
```
    Checks whether the run configuration settings are valid for execution with the specified executor.
    
    Parameters:
    
    executor - the executor which will be used to run the configuration, or null if the check is not specific to an executor.
    
    Throws:
    
    RuntimeConfigurationException - if the configuration settings contain a non-fatal problem which the user should be warned about but the execution should still be allowed
    
    RuntimeConfigurationError - if the configuration settings contain a fatal problem which makes it impossible to execute the run configuration.
  - canRunOn
```
@Deprecated
default boolean canRunOn(ExecutionTarget target)
```
    Deprecated. use ExecutionTargetManager.canRun(RunnerAndConfigurationSettings, ExecutionTarget) instead
  - createFactory
```
Factory<RunnerAndConfigurationSettings> createFactory()
```
    Returns a factory object which can be used to create a copy of this configuration.
    
    Returns:
    
    copying factory instance
  - setEditBeforeRun
```
void setEditBeforeRun(boolean b)
```
    Sets the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
    
    Parameters:
    
    b - if true, the settings dialog will be displayed before launching this configuration.
  - isEditBeforeRun
```
boolean isEditBeforeRun()
```
    Returns the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
    
    Returns:
    
    if true, the settings dialog will be displayed before launching this configuration.
  - setActivateToolWindowBeforeRun
```
void setActivateToolWindowBeforeRun(boolean value)
```
    Sets the "Before launch: Activate tool window" flag (for activation tool window Run/Debug etc.)
    
    Parameters:
    
    value - if true, the tool window will be activated before launching this configuration.
  - isActivateToolWindowBeforeRun
```
boolean isActivateToolWindowBeforeRun()
```
    Returns the "Before launch: Activate tool window" flag (for activation tool window Run/Debug etc.)
    
    Returns:
    
    if true (it's default value), the tool window will be activated before launching this configuration.
  - isSingleton
```
@Deprecated
default boolean isSingleton()
```
    Deprecated. Use RunConfiguration.isAllowRunningInParallel()
  - setSingleton
```
@Deprecated
default void setSingleton(boolean value)
```
    Deprecated. Use RunConfiguration.setAllowRunningInParallel(boolean)}
  - setFolderName
```
void setFolderName(java.lang.String folderName)
```
    Sets the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
    
    Parameters:
    
    folderName - the folder name, or null if the configuration is displayed on the top level.
  - getFolderName
```
java.lang.String getFolderName()
```
    Returns the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
    
    Returns:
    
    the folder name, or null if the configuration is displayed on the top level.

Interface RunnerAndConfigurationSettings

Method Summary

Method Detail

getType

getFactory

isTemplate

isTemporary

isShared

setShared

storeInLocalWorkspace

isStoredInLocalWorkspace

storeInDotIdeaFolder

isStoredInDotIdeaFolder

storeInArbitraryFileInProject

isStoredInArbitraryFileInProject

getPathIfStoredInArbitraryFileInProject

setTemporary

getConfiguration

setName

getName

getUniqueID

getRunnerSettings

getConfigurationSettings

checkSettings

checkSettings

canRunOn

createFactory

setEditBeforeRun

isEditBeforeRun

setActivateToolWindowBeforeRun

isActivateToolWindowBeforeRun

isSingleton

setSingleton

setFolderName

getFolderName