Package com.intellij.execution.jar

Class JarApplicationConfiguration

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

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

com.intellij.execution.configurations.LocatableConfigurationBase

com.intellij.execution.jar.JarApplicationConfiguration

All Implemented Interfaces:

CommonJavaRunConfigurationParameters, CommonProgramRunConfigurationParameters, ConfigurationCreationListener, ConfigurationWithAlternativeJre, LocatableConfiguration, RunConfiguration, RunProfile, SearchScopeProvidingRunProfile, TargetAwareRunProfile, InputRedirectAware, TargetEnvironmentAwareRunProfile, UserDataHolder, UserDataHolderEx, java.lang.Cloneable

public class JarApplicationConfiguration
extends LocatableConfigurationBase
implements CommonJavaRunConfigurationParameters, SearchScopeProvidingRunProfile, InputRedirectAware, TargetEnvironmentAwareRunProfile

Nested Class Summary

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 interface com.intellij.execution.InputRedirectAware

TYPES_WITH_REDIRECT_AWARE_UI

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

DATA_KEY

Constructor Summary

Constructors

Constructor and Description
JarApplicationConfiguration(Project project, ConfigurationFactory factory, java.lang.String name)

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.
RunConfiguration	clone() Clones the 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.
java.lang.String	getDefaultTargetName()
java.util.Map<java.lang.String,java.lang.String>	getEnvs()
InputRedirectAware.InputRedirectOptions	getInputRedirectOptions()
java.lang.String	getJarPath()
Module	getModule()
Module []	getModules()
java.lang.String	getPackage()
java.lang.String	getProgramParameters()
java.lang.String	getRunClass()
GlobalSearchScope	getSearchScope()
RunProfileState	getState(Executor executor, ExecutionEnvironment environment) Prepares for executing a specific instance of the run configuration.
java.lang.String	getVMParameters()
java.lang.String	getWorkingDirectory()
boolean	isAlternativeJrePathEnabled()
boolean	isPassParentEnvs()
void	onNewConfigurationCreated() Called when configuration created via UI (Add Configuration).
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	setJarPath(java.lang.String jarPath)
void	setModule(Module module)
void	setPassParentEnvs(boolean passParentEnvs)
void	setProgramParameters(java.lang.String value)
void	setVMParameters(java.lang.String value)
void	setWorkingDirectory(java.lang.String value)
void	writeExternal(Element element)

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

getActionName, getDefaultOptionsClass, getOptions, 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, getState, hashCode, isAllowRunningInParallel, isNewSerializationUsed, isSaveOutputToFile, isShowConsoleOnStdErr, isShowConsoleOnStdOut, loadState, onConfigurationCopied, removeAllLogFiles, removeAllPredefinedLogFiles, setAllowRunningInParallel, setBeforeRunTasks, setFileOutputPath, setName, setOptionsFromConfigurationFile, 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.InputRedirectAware

getInputFile, getInputRedirectOptions

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

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

suggestedName

Constructor Detail

JarApplicationConfiguration

public JarApplicationConfiguration(Project project,
                                   ConfigurationFactory factory,
                                   java.lang.String name)

Method Detail

getInputRedirectOptions

public InputRedirectAware.InputRedirectOptions getInputRedirectOptions()

Specified by:

getInputRedirectOptions in interface InputRedirectAware

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.

readExternal

public void readExternal(Element element)

Specified by:

readExternal in interface RunConfiguration

Overrides:

readExternal in class RunConfigurationBase

clone

public RunConfiguration clone()

Description copied from interface: RunConfiguration

Clones the run configuration.

Specified by:

clone in interface RunConfiguration

Overrides:

clone in class RunConfigurationBase

Returns:

a clone of this run configuration.

setModule

public void setModule(Module module)

getModule

public Module getModule()

writeExternal

public void writeExternal(Element element)

Specified by:

writeExternal in interface RunConfiguration

Overrides:

writeExternal in class RunConfigurationBase

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.

getModules

public Module [] getModules()

getSearchScope

public GlobalSearchScope getSearchScope()

Specified by:

getSearchScope in interface SearchScopeProvidingRunProfile

Returns:

scope where to search sources for this configuration

getState

public RunProfileState getState(Executor executor,
                                ExecutionEnvironment environment)
                         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.)

environment - 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

getJarPath

public java.lang.String getJarPath()

setJarPath

public void setJarPath(java.lang.String jarPath)

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

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

getRunClass

public java.lang.String getRunClass()

Specified by:

getRunClass in interface CommonJavaRunConfigurationParameters

getPackage

public java.lang.String getPackage()

Specified by:

getPackage 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

setEnvs

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

Specified by:

setEnvs in interface CommonProgramRunConfigurationParameters

getEnvs

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

Specified by:

getEnvs in interface CommonProgramRunConfigurationParameters

setPassParentEnvs

public void setPassParentEnvs(boolean passParentEnvs)

Specified by:

setPassParentEnvs in interface CommonProgramRunConfigurationParameters

isPassParentEnvs

public boolean isPassParentEnvs()

Specified by:

isPassParentEnvs in interface CommonProgramRunConfigurationParameters

onNewConfigurationCreated

public void onNewConfigurationCreated()

Description copied from class: RunConfigurationBase

Called when configuration created via UI (Add Configuration). Suitable to perform some initialization tasks (in most cases it is indicator that you do something wrong, so, please override this method with care and only if really need).

Specified by:

onNewConfigurationCreated in interface ConfigurationCreationListener

Overrides:

onNewConfigurationCreated in class RunConfigurationBase

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

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