Package com.intellij.execution.application

Class ApplicationConfiguration

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.configurations.RunConfigurationBase<T>

com.intellij.execution.configurations.LocatableConfigurationBase<T>

com.intellij.execution.configurations.ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

com.intellij.execution.application.ApplicationConfiguration

All Implemented Interfaces:

CommonJavaRunConfigurationParameters, CommonProgramRunConfigurationParameters, ConfigurationCreationListener, ConfigurationWithAlternativeJre, LocatableConfiguration, ModuleRunConfiguration, ModuleRunProfile, RefactoringListenerProvider, RunConfiguration, RunProfile, RunProfileWithCompileBeforeLaunchOption, SearchScopeProvidingRunProfile, TargetAwareRunProfile, ConfigurationWithCommandLineShortener, InputRedirectAware, SingleClassConfiguration, TargetEnvironmentAwareRunProfile, UserDataHolder, UserDataHolderEx, java.lang.Cloneable

Direct Known Subclasses:

JavaScratchConfiguration

public class ApplicationConfiguration
extends ModuleBasedConfiguration<JavaRunConfigurationModule,Element>
implements CommonJavaRunConfigurationParameters, ConfigurationWithCommandLineShortener, SingleClassConfiguration, RefactoringListenerProvider, InputRedirectAware, TargetEnvironmentAwareRunProfile

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationConfiguration.JavaApplicationCommandLineState<T extends ApplicationConfiguration>

Nested classes/interfaces inherited from interface com.intellij.execution.InputRedirectAware

InputRedirectAware.InputRedirectOptions, InputRedirectAware.InputRedirectOptionsImpl

Nested classes/interfaces inherited from interface com.intellij.execution.configurations.RunConfiguration

RunConfiguration.RestartSingletonResult

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	ALTERNATIVE_JRE_PATH Deprecated.
boolean	ALTERNATIVE_JRE_PATH_ENABLED Deprecated.
java.lang.String	MAIN_CLASS_NAME Deprecated.
java.lang.String	PROGRAM_PARAMETERS Deprecated.
java.lang.String	WORKING_DIRECTORY Deprecated.

Fields inherited from class com.intellij.execution.configurations.ModuleBasedConfiguration

TO_CLONE_ELEMENT_NAME

Fields inherited from interface com.intellij.execution.InputRedirectAware

TYPES_WITH_REDIRECT_AWARE_UI

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

DATA_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
	ApplicationConfiguration(java.lang.String name, Project project)
	ApplicationConfiguration(java.lang.String name, Project project, ApplicationConfigurationType configurationType)
protected	ApplicationConfiguration(java.lang.String name, Project project, ConfigurationFactory factory)

Method Summary

Modifier and Type	Method and Description
boolean	canRunOn(TargetEnvironmentConfiguration target) Checks if this configuration supports running on the provided target (see ExecutionTarget for details).
void	checkConfiguration() Checks whether the run configuration settings are valid.
java.lang.String	getActionName() Returns the text of the context menu action to start this run configuration.
java.lang.String	getAlternativeJrePath()
SettingsEditor<? extends RunConfiguration>	getConfigurationEditor() Returns the UI control for editing the run configuration settings.
<any>	getDefaultLanguageRuntimeType() Returns language runtime type that should be configured for TargetEnvironmentConfiguration if it's created for this particular run configuration.
protected java.lang.Class<? extends JvmMainMethodRunConfigurationOptions>	getDefaultOptionsClass() Do not override this method, it is intended to support old (not migrated to options class) run configurations.
java.lang.String	getDefaultTargetName()
java.util.Map<java.lang.String,java.lang.String>	getEnvs()
InputRedirectAware.InputRedirectOptions	getInputRedirectOptions()
PsiClass	getMainClass()
java.lang.String	getMainClassName()
protected JvmMainMethodRunConfigurationOptions	getOptions() Because we have to keep backward compatibility, never use `getOptions()` to get or set values - use only designated getters/setters.
java.lang.String	getPackage()
java.lang.String	getProgramParameters()
RefactoringElementListener	getRefactoringElementListener(PsiElement element) Returns a listener to handle a rename or move refactoring of the specified PSI element.
java.lang.String	getRunClass()
ShortenCommandLine	getShortenCommandLine()
RunProfileState	getState(Executor executor, ExecutionEnvironment env) Prepares for executing a specific instance of the run configuration.
java.util.Collection<Module>	getValidModules()
java.lang.String	getVMParameters()
java.lang.String	getWorkingDirectory()
boolean	isAlternativeJrePathEnabled()
boolean	isPassParentEnvs()
boolean	isProvidedScopeIncluded()
boolean	isSwingInspectorEnabled()
static void	onAlternativeJreChanged(boolean changed, Project project)
void	readExternal(Element element)
void	setAlternativeJrePath(java.lang.String path)
void	setAlternativeJrePathEnabled(boolean enabled)
void	setDefaultTargetName(java.lang.String targetName)
void	setEnvs(java.util.Map<java.lang.String,java.lang.String> envs)
void	setIncludeProvidedScope(boolean value)
void	setMainClass(PsiClass psiClass)
void	setMainClassName(java.lang.String qualifiedName)
void	setOptionsFromConfigurationFile(BaseState state)
void	setPassParentEnvs(boolean value)
void	setProgramParameters(java.lang.String value)
void	setShortenCommandLine(ShortenCommandLine mode) Called from UI, when user explicitly selects method to be used to shorten the command line or from the deserialization
void	setSwingInspectorEnabled(boolean value)
void	setVMParameters(java.lang.String value)
void	setWorkingDirectory(java.lang.String value)
java.lang.String	suggestedName() Returns the default name for the run configuration based on its settings (such as the name of class or file to run).
void	writeExternal(Element element)

Methods inherited from class com.intellij.execution.configurations.ModuleBasedConfiguration

canRestoreOriginalModule, clone, createInstance, getAllModules, getConfigurationModule, getModules, getState, isModuleDirMacroSupported, loadState, onNewConfigurationCreated, readModule, restoreOriginalModule, setModule, setModuleName, syncModuleName, writeModule

Methods inherited from class com.intellij.execution.configurations.LocatableConfigurationBase

isGeneratedName, setGeneratedName, setNameChangedByUser

Methods inherited from class com.intellij.execution.configurations.RunConfigurationBase

addLogFile, addLogFile, addPredefinedLogFile, checkRunnerSettings, checkSettingsBeforeRun, collectOutputFromProcessHandler, createAdditionalTabComponents, customizeLogConsole, equals, excludeCompileBeforeLaunchOption, getAllLogFiles, getBeforeRunTasks, getFactory, getIcon, getLogFiles, getName, getOptionsClass, getOptionsForPredefinedLogFile, getOutputFilePath, getPredefinedLogFiles, getProject, hashCode, isAllowRunningInParallel, isNewSerializationUsed, isSaveOutputToFile, isShowConsoleOnStdErr, isShowConsoleOnStdOut, onConfigurationCopied, removeAllLogFiles, removeAllPredefinedLogFiles, setAllowRunningInParallel, setBeforeRunTasks, setFileOutputPath, setName, setSaveOutputToFile, setShowConsoleOnStdErr, setShowConsoleOnStdOut, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.execution.CommonProgramRunConfigurationParameters

getProject

Methods inherited from interface com.intellij.execution.ConfigurationWithCommandLineShortener

getProject

Methods inherited from interface com.intellij.execution.InputRedirectAware

getInputFile, getInputRedirectOptions

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

clone, createRunnerSettings, getBeforeRunTasks, getFactory, getId, getPresentableType, getProject, getRunnerSettingsEditor, getType, getUniqueID, hideDisabledExecutorButtons, isAllowRunningInParallel, restartSingleton, setAllowRunningInParallel, setBeforeRunTasks, setName

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

getIcon, getName

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

getSearchScope

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

isBuildBeforeLaunchAddedByDefault, isBuildProjectOnEmptyModuleList, isExcludeCompileBeforeLaunchOption

Field Detail

MAIN_CLASS_NAME

@Deprecated
public java.lang.String MAIN_CLASS_NAME

Deprecated.

PROGRAM_PARAMETERS

@Deprecated
public java.lang.String PROGRAM_PARAMETERS

Deprecated.

WORKING_DIRECTORY

@Deprecated
public java.lang.String WORKING_DIRECTORY

Deprecated.

ALTERNATIVE_JRE_PATH_ENABLED

@Deprecated
public boolean ALTERNATIVE_JRE_PATH_ENABLED

Deprecated.

ALTERNATIVE_JRE_PATH

@Deprecated
public java.lang.String ALTERNATIVE_JRE_PATH

Deprecated.

Constructor Detail

ApplicationConfiguration

public ApplicationConfiguration(java.lang.String name,
                                Project project,
                                ApplicationConfigurationType configurationType)

ApplicationConfiguration

public ApplicationConfiguration(java.lang.String name,
                                Project project)

ApplicationConfiguration

protected ApplicationConfiguration(java.lang.String name,
                                   Project project,
                                   ConfigurationFactory factory)

Method Detail

getDefaultOptionsClass

protected final java.lang.Class<? extends JvmMainMethodRunConfigurationOptions> getDefaultOptionsClass()

Description copied from class: RunConfigurationBase

Do not override this method, it is intended to support old (not migrated to options class) run configurations.

Overrides:

getDefaultOptionsClass in class ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

getOptions

protected JvmMainMethodRunConfigurationOptions getOptions()

Because we have to keep backward compatibility, never use `getOptions()` to get or set values - use only designated getters/setters.

Overrides:

getOptions in class ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

setMainClass

public void setMainClass(PsiClass psiClass)

Specified by:

setMainClass in interface SingleClassConfiguration

getState

public RunProfileState getState(Executor executor,
                                ExecutionEnvironment env)
                         throws ExecutionException

Description copied from interface: RunProfile

Prepares for executing a specific instance of the run configuration.

Specified by:

getState in interface RunProfile

Parameters:

executor - the execution mode selected by the user (run, debug, profile etc.)

env - the environment object containing additional settings for executing the configuration.

Returns:

the RunProfileState describing the process which is about to be started, or null if it's impossible to start the process.

Throws:

ExecutionException

getConfigurationEditor

public SettingsEditor<? extends RunConfiguration> getConfigurationEditor()

Description copied from interface: RunConfiguration

Returns the UI control for editing the run configuration settings. If additional control over validation is required, the object returned from this method may also implement CheckableRunConfigurationEditor. The returned object can also implement SettingsEditorGroup if the settings it provides need to be displayed in multiple tabs.

Specified by:

getConfigurationEditor in interface RunConfiguration

Returns:

the settings editor component.

getRefactoringElementListener

public RefactoringElementListener getRefactoringElementListener(PsiElement element)

Description copied from interface: RefactoringListenerProvider

Returns a listener to handle a rename or move refactoring of the specified PSI element.

Specified by:

getRefactoringElementListener in interface RefactoringListenerProvider

Parameters:

element - the element on which a refactoring was invoked.

Returns:

the listener to handle the refactoring, or null if the run configuration doesn't care about refactoring of this element.

getMainClass

public PsiClass getMainClass()

Specified by:

getMainClass in interface SingleClassConfiguration

getMainClassName

public java.lang.String getMainClassName()

suggestedName

public java.lang.String suggestedName()

Description copied from interface: LocatableConfiguration

Returns the default name for the run configuration based on its settings (such as the name of class or file to run).

Specified by:

suggestedName in interface LocatableConfiguration

Returns:

the suggested name for the configuration, or null if no name could be suggested based on the current settings (for example, the name of the file to run isn't yet specified). NOTE: Please don't return hard-coded strings which are not based on the current run configuration settings (such as "Unnamed").

getActionName

public java.lang.String getActionName()

Description copied from class: LocatableConfigurationBase

Returns the text of the context menu action to start this run configuration. This can be different from the run configuration name (for example, for a Java unit test method, the context menu shows just the name of the method, whereas the name of the run configuration includes the class name).

Overrides:

getActionName in class LocatableConfigurationBase<Element>

Returns:

the name of the action.

setMainClassName

public void setMainClassName(java.lang.String qualifiedName)

Specified by:

setMainClassName in interface SingleClassConfiguration

checkConfiguration

public void checkConfiguration()
                        throws RuntimeConfigurationException

Description copied from interface: RunConfiguration

Checks whether the run configuration settings are valid. Note that this check may be invoked on every change (i.e. after each character typed in an input field).

Specified by:

checkConfiguration in interface RunConfiguration

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.

setVMParameters

public void setVMParameters(java.lang.String value)

Specified by:

setVMParameters in interface CommonJavaRunConfigurationParameters

getVMParameters

public java.lang.String getVMParameters()

Specified by:

getVMParameters in interface CommonJavaRunConfigurationParameters

setProgramParameters

public void setProgramParameters(java.lang.String value)

Specified by:

setProgramParameters in interface CommonProgramRunConfigurationParameters

getProgramParameters

public java.lang.String getProgramParameters()

Specified by:

getProgramParameters in interface CommonProgramRunConfigurationParameters

setWorkingDirectory

public void setWorkingDirectory(java.lang.String value)

Specified by:

setWorkingDirectory in interface CommonProgramRunConfigurationParameters

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Specified by:

getWorkingDirectory in interface CommonProgramRunConfigurationParameters

setPassParentEnvs

public void setPassParentEnvs(boolean value)

Specified by:

setPassParentEnvs in interface CommonProgramRunConfigurationParameters

getEnvs

public java.util.Map<java.lang.String,java.lang.String> getEnvs()

Specified by:

getEnvs in interface CommonProgramRunConfigurationParameters

setEnvs

public void setEnvs(java.util.Map<java.lang.String,java.lang.String> envs)

Specified by:

setEnvs in interface CommonProgramRunConfigurationParameters

isPassParentEnvs

public boolean isPassParentEnvs()

Specified by:

isPassParentEnvs in interface CommonProgramRunConfigurationParameters

getRunClass

public java.lang.String getRunClass()

Specified by:

getRunClass in interface CommonJavaRunConfigurationParameters

getPackage

public java.lang.String getPackage()

Specified by:

getPackage in interface CommonJavaRunConfigurationParameters

isAlternativeJrePathEnabled

public boolean isAlternativeJrePathEnabled()

Specified by:

isAlternativeJrePathEnabled in interface CommonJavaRunConfigurationParameters

Specified by:

isAlternativeJrePathEnabled in interface ConfigurationWithAlternativeJre

setAlternativeJrePathEnabled

public void setAlternativeJrePathEnabled(boolean enabled)

Specified by:

setAlternativeJrePathEnabled in interface CommonJavaRunConfigurationParameters

getAlternativeJrePath

public java.lang.String getAlternativeJrePath()

Specified by:

getAlternativeJrePath in interface CommonJavaRunConfigurationParameters

Specified by:

getAlternativeJrePath in interface ConfigurationWithAlternativeJre

setAlternativeJrePath

public void setAlternativeJrePath(java.lang.String path)

Specified by:

setAlternativeJrePath in interface CommonJavaRunConfigurationParameters

canRunOn

public boolean canRunOn(TargetEnvironmentConfiguration target)

Description copied from interface: TargetAwareRunProfile

Checks if this configuration supports running on the provided target (see ExecutionTarget for details).

Specified by:

canRunOn in interface TargetAwareRunProfile

Specified by:

canRunOn in interface TargetEnvironmentAwareRunProfile

Overrides:

canRunOn in class RunConfigurationBase<Element>

Parameters:

target - target provided by ExecutionTargetProvider

getDefaultLanguageRuntimeType

public <any> getDefaultLanguageRuntimeType()

Description copied from interface: TargetEnvironmentAwareRunProfile

Returns language runtime type that should be configured for TargetEnvironmentConfiguration if it's created for this particular run configuration.

That language runtime type will be used while creating TargetEnvironmentConfiguration using wizard from RunOnTargetComboBox

Specified by:

getDefaultLanguageRuntimeType in interface TargetEnvironmentAwareRunProfile

See Also:

TargetEnvironmentType#createStepsForNewWizard

getDefaultTargetName

public java.lang.String getDefaultTargetName()

Specified by:

getDefaultTargetName in interface TargetEnvironmentAwareRunProfile

Returns:

display name of target environment to run on

See Also:

TargetEnvironmentConfiguration#getDisplayName()

setDefaultTargetName

public void setDefaultTargetName(java.lang.String targetName)

Specified by:

setDefaultTargetName in interface TargetEnvironmentAwareRunProfile

onAlternativeJreChanged

public static void onAlternativeJreChanged(boolean changed,
                                           Project project)

isProvidedScopeIncluded

public boolean isProvidedScopeIncluded()

setIncludeProvidedScope

public void setIncludeProvidedScope(boolean value)

getValidModules

public java.util.Collection<Module> getValidModules()

Specified by:

getValidModules in class ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

readExternal

public void readExternal(Element element)

Specified by:

readExternal in interface RunConfiguration

Overrides:

readExternal in class ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

setOptionsFromConfigurationFile

public void setOptionsFromConfigurationFile(BaseState state)

Overrides:

setOptionsFromConfigurationFile in class RunConfigurationBase<Element>

writeExternal

public void writeExternal(Element element)

Specified by:

writeExternal in interface RunConfiguration

Overrides:

writeExternal in class ModuleBasedConfiguration<JavaRunConfigurationModule,Element>

getShortenCommandLine

public ShortenCommandLine getShortenCommandLine()

Specified by:

getShortenCommandLine in interface ConfigurationWithCommandLineShortener

Returns:

null if option was not selected explicitly, legacy user-local options to be used

setShortenCommandLine

public void setShortenCommandLine(ShortenCommandLine mode)

Description copied from interface: ConfigurationWithCommandLineShortener

Called from UI, when user explicitly selects method to be used to shorten the command line or from the deserialization

Specified by:

setShortenCommandLine in interface ConfigurationWithCommandLineShortener

getInputRedirectOptions

public InputRedirectAware.InputRedirectOptions getInputRedirectOptions()

Specified by:

getInputRedirectOptions in interface InputRedirectAware

isSwingInspectorEnabled

public boolean isSwingInspectorEnabled()

setSwingInspectorEnabled

public void setSwingInspectorEnabled(boolean value)