oracle.jdeveloper.runner
Class RunConfiguration

java.lang.Object
  oracle.ide.model.DefaultSubDirtyable
      oracle.jdeveloper.runner.RunConfiguration

All Implemented Interfaces:

Copyable, Dirtyable, SubDirtyable

public class RunConfiguration

extends DefaultSubDirtyable

implements Copyable

The RunConfiguration class specifies details about how a Java process should be started.

Field Summary

static java.lang.String

DATA_KEY Use DATA_KEY to get the run configuration from a project.

Constructor Summary

RunConfiguration()
Default constructor.

RunConfiguration(RunConfiguration runConfiguration)
Copy constructor.

Method Summary

java.lang.Object	copyTo(java.lang.Object object) Copies this RunConfiguration's values to the object RunConfiguration.
protected void	copyToImpl(RunConfiguration copy) Copies this RunConfiguration's values to the copy RunConfiguration.
boolean	equals(java.lang.Object o) Returns true if this RunConfiguration equals the o RunConfiguration.
protected boolean	equalsImpl(RunConfiguration rc) Returns true if this RunConfiguration equals the rc RunConfiguration.
boolean	getAlwaysUseTarget() Deprecated. Use isRunActiveFile instead.
java.lang.String	getConnectionName() Returns the database connection name.
java.lang.String	getJavaOptions() Returns the java options.
java.lang.String	getProgramArguments() Returns the program arguments.
java.net.URL	getRunDirectoryURL() Returns the working directory
java.net.URL	getTargetURL() Returns the target URL.
java.lang.String	getVMName() This method is for internal use only and should not be called directly by an addin.
java.lang.String	getVMName(JDK jdk) Returns the name of the Virtual Machine.
java.lang.String	getVMName(JDK jdk, JProject project) Returns the name of the Virtual Machine.
boolean	isAllowInput() Returns whether the user should be able to enter input for System.in.
boolean	isClearLogBeforeRun() Returns whether the log page should be cleared before running.
boolean	isCompileBeforeRun() Returns whether the project should be compiled before running.
boolean	isLogCommand() Returns whether the command should be logged.
boolean	isLogError() Returns whether System.err should be redirected to the log page.
boolean	isLogExit() Returns whether the exit message should be logged.
boolean	isLogOutput() Returns whether System.out should be redirected to the log page.
boolean	isRunActiveFile() Returns whether the active file should be run.
boolean	isUseProxy() Returns whether the proxy options should be used.
void	setAllowInput(boolean allowInput) Sets whether the user should be able to enter input for System.in.
void	setAlwaysUseTarget(boolean alwaysUseTarget) Deprecated. Use setRunActiveFile instead.
void	setClearLogBeforeRun(boolean clearLogBeforeRun) Sets whether the log page should be cleared before running.
void	setCompileBeforeRun(boolean compileBeforeRun) Sets whether the project should be compiled before running.
void	setConnectionName(java.lang.String connectionName) Sets the database connection name.
void	setJavaOptions(java.lang.String javaOptions) Sets the java options.
void	setLogCommand(boolean logCommand) Sets whether the command should be logged.
void	setLogError(boolean logError) Sets whether System.err should be redirected to the log page.
void	setLogExit(boolean logExit) Sets whether the exit message should be logged.
void	setLogOutput(boolean logOutput) Sets whether System.out should be redirected to the log page.
void	setProgramArguments(java.lang.String programArguments) Sets the program arguments.
void	setRunActiveFile(boolean runActiveFile) Sets whether the active file should be run.
void	setRunDirectoryURL(java.net.URL runDirectoryURL) Sets the working directory
void	setTargetURL(java.net.URL targetURL) Sets the target URL.
void	setUseProxy(boolean useProxy) Sets whether the proxy options should be used.
void	setVMName(java.lang.String vmName) Sets the name of the Virtual Machine.
boolean	usingClassic(JDK jdk) Returns true if the Virtual Machine is classic.
boolean	usingMinimal(JDK jdk) Returns true if the Virtual Machine is minimal.
boolean	usingOJVM(JDK jdk) Returns true if the Virtual Machine is ojvm.
boolean	usingVanilla(JDK jdk) Returns true if the Virtual Machine is vanilla.

Methods inherited from class oracle.ide.model.DefaultSubDirtyable

getOwner, isDirty, markDirty, setOwner

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATA_KEY

public static final java.lang.String DATA_KEY

Use DATA_KEY to get the run configuration from a project.

See Also:

JProject.getActiveConfigDataByName(java.lang.String)

Constructor Detail

RunConfiguration

public RunConfiguration()

Default constructor. Required for JavaBean status.

RunConfiguration

public RunConfiguration(RunConfiguration runConfiguration)

Copy constructor.

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object object)

Copies this RunConfiguration's values to the object RunConfiguration.

Specified by:

copyTo in interface Copyable

Parameters:

object - the copy destination

Returns:

the copy

copyToImpl

protected final void copyToImpl(RunConfiguration copy)

Copies this RunConfiguration's values to the copy RunConfiguration.

Parameters:

copy - the copy destination

getRunDirectoryURL

public java.net.URL getRunDirectoryURL()

Returns the working directory

setRunDirectoryURL

public void setRunDirectoryURL(java.net.URL runDirectoryURL)

Sets the working directory

getVMName

public java.lang.String getVMName()

This method is for internal use only and should not be called directly by an addin.

Returns the name of the Virtual Machine. This method might return null, meaning that the user has not chosen a VM.

See Also:

getVMName(JDK), getVMName(JDK,JProject)

getVMName

public java.lang.String getVMName(JDK jdk)

Returns the name of the Virtual Machine.

Verifies that the VM is valid for the JDK.
If the VM is not valid, returns the default VM.

Parameters:

jdk - the JDK

See Also:

getVMName(JDK,JProject)

getVMName

public java.lang.String getVMName(JDK jdk,
                                  JProject project)

Returns the name of the Virtual Machine.

Verifies the the VM is valid for the JDK.
If the VM is not valid, changes the VM to the default VM and marks the project dirty.

Parameters:

jdk - the JDK

project - the project

setVMName

public void setVMName(java.lang.String vmName)

Sets the name of the Virtual Machine.

getJavaOptions

public java.lang.String getJavaOptions()

Returns the java options.

setJavaOptions

public void setJavaOptions(java.lang.String javaOptions)

Sets the java options.

isUseProxy

public boolean isUseProxy()

Returns whether the proxy options should be used.

setUseProxy

public void setUseProxy(boolean useProxy)

Sets whether the proxy options should be used.

getTargetURL

public java.net.URL getTargetURL()

Returns the target URL.

setTargetURL

public void setTargetURL(java.net.URL targetURL)

Sets the target URL.

isRunActiveFile

public boolean isRunActiveFile()

Returns whether the active file should be run.

setRunActiveFile

public void setRunActiveFile(boolean runActiveFile)

Sets whether the active file should be run.

getAlwaysUseTarget

public boolean getAlwaysUseTarget()

Deprecated. Use isRunActiveFile instead.

setAlwaysUseTarget

public void setAlwaysUseTarget(boolean alwaysUseTarget)

Deprecated. Use setRunActiveFile instead.

getProgramArguments

public java.lang.String getProgramArguments()

Returns the program arguments.

setProgramArguments

public void setProgramArguments(java.lang.String programArguments)

Sets the program arguments.

isCompileBeforeRun

public boolean isCompileBeforeRun()

Returns whether the project should be compiled before running.

setCompileBeforeRun

public void setCompileBeforeRun(boolean compileBeforeRun)

Sets whether the project should be compiled before running.

isClearLogBeforeRun

public boolean isClearLogBeforeRun()

Returns whether the log page should be cleared before running.

setClearLogBeforeRun

public void setClearLogBeforeRun(boolean clearLogBeforeRun)

Sets whether the log page should be cleared before running.

isLogCommand

public boolean isLogCommand()

Returns whether the command should be logged.

setLogCommand

public void setLogCommand(boolean logCommand)

Sets whether the command should be logged.

isLogOutput

public boolean isLogOutput()

Returns whether System.out should be redirected to the log page.

setLogOutput

public void setLogOutput(boolean logOutput)

Sets whether System.out should be redirected to the log page.

isLogError

public boolean isLogError()

Returns whether System.err should be redirected to the log page.

setLogError

public void setLogError(boolean logError)

Sets whether System.err should be redirected to the log page.

isAllowInput

public boolean isAllowInput()

Returns whether the user should be able to enter input for System.in.

setAllowInput

public void setAllowInput(boolean allowInput)

Sets whether the user should be able to enter input for System.in.

isLogExit

public boolean isLogExit()

Returns whether the exit message should be logged.

setLogExit

public void setLogExit(boolean logExit)

Sets whether the exit message should be logged.

getConnectionName

public java.lang.String getConnectionName()

Returns the database connection name.

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Sets the database connection name.

equals

public boolean equals(java.lang.Object o)

Returns true if this RunConfiguration equals the o RunConfiguration.

equalsImpl

protected final boolean equalsImpl(RunConfiguration rc)

Returns true if this RunConfiguration equals the rc RunConfiguration.

usingOJVM

public boolean usingOJVM(JDK jdk)

Returns true if the Virtual Machine is ojvm.

usingMinimal

public boolean usingMinimal(JDK jdk)

Returns true if the Virtual Machine is minimal.

usingVanilla

public boolean usingVanilla(JDK jdk)

Returns true if the Virtual Machine is vanilla.

usingClassic

public boolean usingClassic(JDK jdk)

Returns true if the Virtual Machine is classic.