Package com.intellij.remoteServer.impl.configuration.deployment

Class DeployToServerRunConfiguration<S extends ServerConfiguration,D extends DeploymentConfiguration>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

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

com.intellij.remoteServer.impl.configuration.deployment.DeployToServerRunConfiguration<S,D>

All Implemented Interfaces:

ConfigurationCreationListener, LocatableConfiguration, RunConfiguration, RunProfile, TargetAwareRunProfile, UserDataHolder, UserDataHolderEx, java.lang.Cloneable

public class DeployToServerRunConfiguration<S extends ServerConfiguration,D extends DeploymentConfiguration>
extends RunConfigurationBase<Element>
implements LocatableConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployToServerRunConfiguration.ConfigurationState

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

RunConfiguration.RestartSingletonResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SETTINGS_ELEMENT

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

DATA_KEY

Constructor Summary

Constructors

Constructor and Description
DeployToServerRunConfiguration(Project project, ConfigurationFactory factory, java.lang.String name, ServerType<S> serverType, DeploymentConfigurator<D,S> deploymentConfigurator)

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks whether the run configuration settings are valid.
RunConfiguration	clone() Clones the run configuration.
SettingsEditor<DeployToServerRunConfiguration>	getConfigurationEditor() Returns the UI control for editing the run configuration settings.
D	getDeploymentConfiguration()
DeploymentSource	getDeploymentSource()
java.lang.String	getServerName()
ServerType<S>	getServerType()
RunProfileState	getState(Executor executor, ExecutionEnvironment env) Prepares for executing a specific instance of the run configuration.
boolean	isGeneratedName() Checks if the current name for the run configuration was automatically generated.
void	onNewConfigurationCreated() Called when configuration created via UI (Add Configuration).
void	readExternal(Element element)
void	setDeploymentConfiguration(D deploymentConfiguration)
void	setDeploymentSource(DeploymentSource deploymentSource)
void	setServerName(java.lang.String serverName)
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.RunConfigurationBase

addLogFile, addLogFile, addPredefinedLogFile, canRunOn, checkRunnerSettings, checkSettingsBeforeRun, collectOutputFromProcessHandler, createAdditionalTabComponents, customizeLogConsole, equals, excludeCompileBeforeLaunchOption, getAllLogFiles, getBeforeRunTasks, getDefaultOptionsClass, getFactory, getIcon, getLogFiles, getName, getOptions, 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.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

Field Detail

SETTINGS_ELEMENT

public static final java.lang.String SETTINGS_ELEMENT

See Also:

Constant Field Values

Constructor Detail

DeployToServerRunConfiguration

public DeployToServerRunConfiguration(Project project,
                                      ConfigurationFactory factory,
                                      java.lang.String name,
                                      ServerType<S> serverType,
                                      DeploymentConfigurator<D,S> deploymentConfigurator)

Method Detail

getServerType

public ServerType<S> getServerType()

getServerName

public java.lang.String getServerName()

getConfigurationEditor

public SettingsEditor<DeployToServerRunConfiguration> 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.

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

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.

setServerName

public void setServerName(java.lang.String serverName)

getDeploymentSource

public DeploymentSource getDeploymentSource()

setDeploymentSource

public void setDeploymentSource(DeploymentSource deploymentSource)

getDeploymentConfiguration

public D getDeploymentConfiguration()

setDeploymentConfiguration

public void setDeploymentConfiguration(D deploymentConfiguration)

isGeneratedName

public boolean isGeneratedName()

Description copied from interface: LocatableConfiguration

Checks if the current name for the run configuration was automatically generated.

Specified by:

isGeneratedName in interface LocatableConfiguration

Returns:

true if the name was generated by LocatableConfiguration.suggestedName(), false if it was manually entered or changed by the user.

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").

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface RunConfiguration

Overrides:

readExternal in class RunConfigurationBase<Element>

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Specified by:

writeExternal in interface RunConfiguration

Overrides:

writeExternal in class RunConfigurationBase<Element>

Throws:

WriteExternalException

clone

public RunConfiguration clone()

Description copied from interface: RunConfiguration

Clones the run configuration.

Specified by:

clone in interface RunConfiguration

Overrides:

clone in class RunConfigurationBase<Element>

Returns:

a clone of this run configuration.

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