Package com.intellij.execution.scratch

Class JavaScratchConfiguration

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

com.intellij.execution.scratch.JavaScratchConfiguration

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

public class JavaScratchConfiguration
extends ApplicationConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.execution.application.ApplicationConfiguration

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 inherited from class com.intellij.execution.application.ApplicationConfiguration

ALTERNATIVE_JRE_PATH, ALTERNATIVE_JRE_PATH_ENABLED, MAIN_CLASS_NAME, PROGRAM_PARAMETERS, WORKING_DIRECTORY

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
protected	JavaScratchConfiguration(java.lang.String name, Project project, ConfigurationFactory factory)

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks whether the run configuration settings are valid.
SettingsEditor<? extends RunConfiguration>	getConfigurationEditor() Returns the UI control for editing the run configuration settings.
protected JavaScratchConfigurationOptions	getOptions() Because we have to keep backward compatibility, never use `getOptions()` to get or set values - use only designated getters/setters.
java.lang.String	getScratchFileUrl()
VirtualFile	getScratchVirtualFile()
RunProfileState	getState(Executor executor, ExecutionEnvironment env) Prepares for executing a specific instance of the run configuration.
boolean	isBuildProjectOnEmptyModuleList() Modifies behavior for the case when RunProfileWithCompileBeforeLaunchOption.getModules() returns empty list.
void	setScratchFileUrl(java.lang.String url)

Methods inherited from class com.intellij.execution.application.ApplicationConfiguration

canRunOn, getActionName, getAlternativeJrePath, getDefaultLanguageRuntimeType, getDefaultOptionsClass, getDefaultTargetName, getEnvs, getInputRedirectOptions, getMainClass, getMainClassName, getPackage, getProgramParameters, getRefactoringElementListener, getRunClass, getShortenCommandLine, getValidModules, getVMParameters, getWorkingDirectory, isAlternativeJrePathEnabled, isPassParentEnvs, isProvidedScopeIncluded, isSwingInspectorEnabled, onAlternativeJreChanged, readExternal, setAlternativeJrePath, setAlternativeJrePathEnabled, setDefaultTargetName, setEnvs, setIncludeProvidedScope, setMainClass, setMainClassName, setOptionsFromConfigurationFile, setPassParentEnvs, setProgramParameters, setShortenCommandLine, setSwingInspectorEnabled, setVMParameters, setWorkingDirectory, suggestedName, writeExternal

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, isExcludeCompileBeforeLaunchOption

Constructor Detail

JavaScratchConfiguration

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

Method Detail

isBuildProjectOnEmptyModuleList

public boolean isBuildProjectOnEmptyModuleList()

Description copied from interface: RunProfileWithCompileBeforeLaunchOption

Modifies behavior for the case when RunProfileWithCompileBeforeLaunchOption.getModules() returns empty list. By default whole project will be built in this case.

Returns:

true if whole project is to be built when no particular module is selected, false effectively skips project compilation

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

Overrides:

checkConfiguration in class ApplicationConfiguration

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.

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

Overrides:

getState in class ApplicationConfiguration

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

Overrides:

getConfigurationEditor in class ApplicationConfiguration

Returns:

the settings editor component.

setScratchFileUrl

public void setScratchFileUrl(java.lang.String url)

getScratchFileUrl

public java.lang.String getScratchFileUrl()

getScratchVirtualFile

public VirtualFile getScratchVirtualFile()

getOptions

protected JavaScratchConfigurationOptions getOptions()

Description copied from class: ApplicationConfiguration

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

Overrides:

getOptions in class ApplicationConfiguration