oracle.jdeveloper.runner
Class RunConfiguration

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.jdeveloper.runner.RunConfiguration

All Implemented Interfaces:

PropertyStorage

public class RunConfiguration
extends HashStructureAdapter
implements PropertyStorage

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

Field Summary

static java.lang.String	ALLOW_INPUT
static java.lang.String	CLEAR_LOG_BEFORE_RUN
static java.lang.String	COMPILE_BEFORE_RUN
static java.lang.String	COMPILE_PROJECT_AND_DEPENDENCIES_BEFORE_RUN
static java.lang.String	COMPILE_PROJECT_ONLY_BEFORE_RUN
static java.lang.String	CONNECTION_NAME Constant for accessing the database connection name in property storage
static java.lang.String	CUSTOM Key used to return whether RunConfiguration is custom from property storage
static java.lang.String	JAVA_OPTIONS
static java.lang.String	JS_RUN_CONFIGURATION_BROWSER_EXECUTABLE
static java.lang.String	JS_RUN_CONFIGURATION_ENABLE_BEBUG_STATEMENT
static java.lang.String	JS_RUN_CONFIGURATION_STOP_IN_CHROME
static java.lang.String	JS_RUN_CONFIGURATION_STOP_ON_ERROR
static java.lang.String	JS_RUN_CONFIGURATION_STOP_ON_EXCEPTION
static java.lang.String	JS_RUN_CONFIGURATION_TRANSFER_ERRORS
static java.lang.String	JS_RUN_CONFIGURATION_TYPE
static java.lang.String	LOG_COMMAND
static java.lang.String	LOG_ERROR
static java.lang.String	LOG_EXIT
static java.lang.String	LOG_OUTPUT
static java.lang.String	NAME Key used to retrieve the RunConfiguration name from property storage
static java.lang.String	PROGRAM_ARGUMENTS
static java.lang.String	REMOTE_DEBUGGING_PROFILING
static java.lang.String	RUN_ACTIVE_FILE
static java.lang.String	RUN_ANT_BEFORE_RUN
static java.lang.String	RUN_CONFIGURATION_NAME
static java.lang.String	RUN_DIRECTORY_URL Key used to return RunConfiguration working directory from property storage
static java.lang.String	SAVE_ALL_BEFORE_RUN
static java.lang.String	TARGET_URL
static java.lang.String	USE_PROXY
static java.lang.String	VM_NAME Key used to return RunConfiguration Virtual Machine name from property storage

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Fields inherited from interface oracle.javatools.data.PropertyStorage

DATA_KEY

Constructor Summary

RunConfiguration()

RunConfiguration(HashStructure hash)

RunConfiguration(RunConfiguration copyFrom, java.lang.String name, boolean custom)
Creates a new RunConfiguration which is a copy of another one IMPORTANT: Do NOT use '/' characters in the RunConfiguration name

Method Summary

static RunConfiguration	createNewInstance(HashStructure hash, java.lang.String name, boolean isCustom) Create a new RunConfiguration
java.lang.String	getConnectionName() Returns the database connection name.
static java.lang.String	getDefaultName() Return the default name for a run configuration
static RunConfiguration	getInstance(PropertyStorage propertyStorage) Returns the active RunConfiguration for a Project
java.lang.String	getJavaOptions() Returns the java options.
java.lang.String	getJSRunConfigurationBrowserExecutable()
java.lang.String	getJSRunConfigurationEnableDebug() Returns whether the run configuration enables the JavaScript 'debugger' statement
java.lang.String	getJSRunConfigurationStopInChrome()
java.lang.String	getJSRunConfigurationStopOnError() Returns whether JavaScript execution should stop on encountering an error
java.lang.String	getJSRunConfigurationStopOnException() Returns whether JavaScript execution should stop on encountering an exception
java.lang.String	getJSRunConfigurationTransferErrors() Returns whether JavaScript execution should transfer errors
java.lang.String	getJSRunConfigurationType() Returns the JavaScript RunConfiguration type
java.lang.String	getName() Returns the name.
java.lang.String	getProgramArguments() Returns the program arguments.
HashStructure	getProperties() Return the HashStructure containing properties for the RunConfiguration
static RunConfiguration	getRunConfiguration(Project project, java.lang.String configName) Deprecated. Call getInstance(oracle.javatools.data.PropertyStorage) instead.
java.net.URL	getRunDirectoryURL() Returns the working directory
java.net.URL	getTargetURL() Returns the target URL.
java.lang.String	getVMName(JDK jdk) Returns the name of the Virtual Machine.
java.lang.String	getVMName(JDK jdk, Project 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 (and dependencies) should be compiled before running.
boolean	isCustom() Returns whether this run configuration is custom.
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	isRemoteDebuggingProfiling() Returns whether remote debugging and profiling.
boolean	isRunActiveFile() Returns whether the active file should be run.
boolean	isRunAntBeforeRun() Returns whether to run Ant before running.
boolean	isSaveAllBeforeRun() Returns whether all files should be saved before running.
boolean	isUseProxy() Returns whether the proxy options should be used.
void	restoreDefaults() Restore default values.
void	setAllowInput(boolean allowInput) Sets whether the user should be able to enter input for System.in.
void	setClearLogBeforeRun(boolean clearLogBeforeRun) Sets whether the log page should be cleared before running.
void	setCompileBeforeRun(boolean compileBeforeRun) Sets whether the project (and dependencies) should be compiled before running.
void	setConnectionName(java.lang.String connectionName) Sets the database connection name.
void	setCustom(boolean custom) Sets whether this run configuration is custom.
void	setJavaOptions(java.lang.String javaOptions) Sets the java options.
void	setJSRunConfigurationBrowserExecutable(java.lang.String connectionName)
void	setJSRunConfigurationEnableDebug(java.lang.String connectionName) Sets whether the run configuration should enable the JavaScript 'debugger' statement
void	setJSRunConfigurationStopInChrome(java.lang.String connectionName)
void	setJSRunConfigurationStopOnError(java.lang.String connectionName) Turn on stop on error behavior for JavaScript execution
void	setJSRunConfigurationStopOnException(java.lang.String connectionName) Turn on stop on exception behavior for JavaScript execution
void	setJSRunConfigurationTransferErrors(java.lang.String connectionName) Set option to transfer errors in JavaScript
void	setJSRunConfigurationType(java.lang.String connectionName) Sets the JavaScript RunConfiguration type.
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	setName(java.lang.String name) Sets the name.
void	setProgramArguments(java.lang.String programArguments) Sets the program arguments.
void	setRemoteDebuggingProfiling(boolean remoteDebuggingProfiling) Sets whether remote debugging and profiling.
void	setRunActiveFile(boolean runActiveFile) Sets whether the active file should be run.
void	setRunAntBeforeRun(boolean runAntBeforeRun) Sets whether to run Ant before running.
void	setRunDirectoryURL(java.net.URL runDirectoryURL) Sets the working directory
void	setSaveAllBeforeRun(boolean saveAllBeforeRun)
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.
java.lang.String	toString() Returns the name of the RunConfiguration
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.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Field Detail

RUN_CONFIGURATION_NAME

public static final java.lang.String RUN_CONFIGURATION_NAME

See Also:

Constant Field Values

REMOTE_DEBUGGING_PROFILING

public static final java.lang.String REMOTE_DEBUGGING_PROFILING

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Key used to retrieve the RunConfiguration name from property storage

See Also:

Constant Field Values

CUSTOM

public static final java.lang.String CUSTOM

Key used to return whether RunConfiguration is custom from property storage

See Also:

Constant Field Values

RUN_DIRECTORY_URL

public static final java.lang.String RUN_DIRECTORY_URL

Key used to return RunConfiguration working directory from property storage

See Also:

Constant Field Values

VM_NAME

public static final java.lang.String VM_NAME

Key used to return RunConfiguration Virtual Machine name from property storage

See Also:

Constant Field Values

JAVA_OPTIONS

public static final java.lang.String JAVA_OPTIONS

See Also:

Constant Field Values

TARGET_URL

public static final java.lang.String TARGET_URL

See Also:

Constant Field Values

RUN_ACTIVE_FILE

public static final java.lang.String RUN_ACTIVE_FILE

See Also:

Constant Field Values

PROGRAM_ARGUMENTS

public static final java.lang.String PROGRAM_ARGUMENTS

See Also:

Constant Field Values

CONNECTION_NAME

public static final java.lang.String CONNECTION_NAME

Constant for accessing the database connection name in property storage

See Also:

Constant Field Values

COMPILE_BEFORE_RUN

public static final java.lang.String COMPILE_BEFORE_RUN

See Also:

Constant Field Values

COMPILE_PROJECT_ONLY_BEFORE_RUN

public static final java.lang.String COMPILE_PROJECT_ONLY_BEFORE_RUN

See Also:

Constant Field Values

COMPILE_PROJECT_AND_DEPENDENCIES_BEFORE_RUN

public static final java.lang.String COMPILE_PROJECT_AND_DEPENDENCIES_BEFORE_RUN

See Also:

Constant Field Values

RUN_ANT_BEFORE_RUN

public static final java.lang.String RUN_ANT_BEFORE_RUN

See Also:

Constant Field Values

CLEAR_LOG_BEFORE_RUN

public static final java.lang.String CLEAR_LOG_BEFORE_RUN

See Also:

Constant Field Values

SAVE_ALL_BEFORE_RUN

public static final java.lang.String SAVE_ALL_BEFORE_RUN

See Also:

Constant Field Values

LOG_COMMAND

public static final java.lang.String LOG_COMMAND

See Also:

Constant Field Values

LOG_OUTPUT

public static final java.lang.String LOG_OUTPUT

See Also:

Constant Field Values

LOG_ERROR

public static final java.lang.String LOG_ERROR

See Also:

Constant Field Values

ALLOW_INPUT

public static final java.lang.String ALLOW_INPUT

See Also:

Constant Field Values

LOG_EXIT

public static final java.lang.String LOG_EXIT

See Also:

Constant Field Values

USE_PROXY

public static final java.lang.String USE_PROXY

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_TYPE

public static final java.lang.String JS_RUN_CONFIGURATION_TYPE

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_ENABLE_BEBUG_STATEMENT

public static final java.lang.String JS_RUN_CONFIGURATION_ENABLE_BEBUG_STATEMENT

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_STOP_ON_ERROR

public static final java.lang.String JS_RUN_CONFIGURATION_STOP_ON_ERROR

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_STOP_ON_EXCEPTION

public static final java.lang.String JS_RUN_CONFIGURATION_STOP_ON_EXCEPTION

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_TRANSFER_ERRORS

public static final java.lang.String JS_RUN_CONFIGURATION_TRANSFER_ERRORS

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_STOP_IN_CHROME

public static final java.lang.String JS_RUN_CONFIGURATION_STOP_IN_CHROME

See Also:

Constant Field Values

JS_RUN_CONFIGURATION_BROWSER_EXECUTABLE

public static final java.lang.String JS_RUN_CONFIGURATION_BROWSER_EXECUTABLE

See Also:

Constant Field Values

Constructor Detail

RunConfiguration

public RunConfiguration(HashStructure hash)

RunConfiguration

public RunConfiguration()

RunConfiguration

public RunConfiguration(RunConfiguration copyFrom,
                        java.lang.String name,
                        boolean custom)

Creates a new RunConfiguration which is a copy of another one IMPORTANT: Do NOT use '/' characters in the RunConfiguration name

Parameters:

copyFrom - The RunConfiguration to copy from

name - The name of the RunConfiguration

custom - True if this is a custom RunConfiguration

Method Detail

getInstance

public static RunConfiguration getInstance(PropertyStorage propertyStorage)

Returns the active RunConfiguration for a Project

Parameters:

propertyStorage - if a Project is passed in, the active RunConfiguration for that Project is returned. If the parameter is not a Project then null will be returned.

Returns:

the active RunConfiguration for the project, or null.

getRunConfiguration

public static RunConfiguration getRunConfiguration(Project project,
                                                   java.lang.String configName)

Deprecated. Call getInstance(oracle.javatools.data.PropertyStorage) instead.

createNewInstance

public static RunConfiguration createNewInstance(HashStructure hash,
                                                 java.lang.String name,
                                                 boolean isCustom)

Create a new RunConfiguration

Parameters:

hash - The HashStructure for the storage of the RunConfiguration; if null a default HashStructure will be created

name - The name of the RunConfiguration; if null, a default name will be assigned

isCustom - Sets the custom flag of the RunConfiguration. Custom RunConfigurations are stored in the user properties, non-custom ones in the shared properties

Returns:

The new RunConfiguration

getDefaultName

public static java.lang.String getDefaultName()

Return the default name for a run configuration

toString

public java.lang.String toString()

Returns the name of the RunConfiguration

Overrides:

toString in class java.lang.Object

getProperties

public HashStructure getProperties()

Return the HashStructure containing properties for the RunConfiguration

Specified by:

getProperties in interface PropertyStorage

Returns:

The HashStructure wrapped by this PropertyStorage.

restoreDefaults

public void restoreDefaults()

Restore default values. Everything other than the name and isCustom setting will be cleared.

getName

public java.lang.String getName()

Returns the name.

setName

public void setName(java.lang.String name)

Sets the name. IMPORTANT: Do NOT use '/' characters in the RunConfiguration name

isCustom

public boolean isCustom()

Returns whether this run configuration is custom.

setCustom

public void setCustom(boolean custom)

Sets whether this run configuration is custom.

getRunDirectoryURL

public java.net.URL getRunDirectoryURL()

Returns the working directory

setRunDirectoryURL

public void setRunDirectoryURL(java.net.URL runDirectoryURL)

Sets the working directory

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.

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.

getProgramArguments

public java.lang.String getProgramArguments()

Returns the program arguments.

setProgramArguments

public void setProgramArguments(java.lang.String programArguments)

Sets the program arguments.

isRemoteDebuggingProfiling

public boolean isRemoteDebuggingProfiling()

Returns whether remote debugging and profiling.

setRemoteDebuggingProfiling

public void setRemoteDebuggingProfiling(boolean remoteDebuggingProfiling)

Sets whether remote debugging and profiling.

getConnectionName

public java.lang.String getConnectionName()

Returns the database connection name.

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Sets the database connection name.

isCompileBeforeRun

public boolean isCompileBeforeRun()

Returns whether the project (and dependencies) should be compiled before running.

setCompileBeforeRun

public void setCompileBeforeRun(boolean compileBeforeRun)

Sets whether the project (and dependencies) should be compiled before running.

isRunAntBeforeRun

public boolean isRunAntBeforeRun()

Returns whether to run Ant before running.

setRunAntBeforeRun

public void setRunAntBeforeRun(boolean runAntBeforeRun)

Sets whether to run Ant 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.

isSaveAllBeforeRun

public boolean isSaveAllBeforeRun()

Returns whether all files should be saved before running.

setSaveAllBeforeRun

public void setSaveAllBeforeRun(boolean saveAllBeforeRun)

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.

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.

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,
                                  Project project)

Returns the name of the Virtual Machine.

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

Parameters:

jdk - the JDK

project - the project

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.

getJSRunConfigurationType

public java.lang.String getJSRunConfigurationType()

Returns the JavaScript RunConfiguration type

setJSRunConfigurationType

public void setJSRunConfigurationType(java.lang.String connectionName)

Sets the JavaScript RunConfiguration type.

getJSRunConfigurationEnableDebug

public java.lang.String getJSRunConfigurationEnableDebug()

Returns whether the run configuration enables the JavaScript 'debugger' statement

setJSRunConfigurationEnableDebug

public void setJSRunConfigurationEnableDebug(java.lang.String connectionName)

Sets whether the run configuration should enable the JavaScript 'debugger' statement

getJSRunConfigurationStopOnError

public java.lang.String getJSRunConfigurationStopOnError()

Returns whether JavaScript execution should stop on encountering an error

setJSRunConfigurationStopOnError

public void setJSRunConfigurationStopOnError(java.lang.String connectionName)

Turn on stop on error behavior for JavaScript execution

getJSRunConfigurationStopOnException

public java.lang.String getJSRunConfigurationStopOnException()

Returns whether JavaScript execution should stop on encountering an exception

setJSRunConfigurationStopOnException

public void setJSRunConfigurationStopOnException(java.lang.String connectionName)

Turn on stop on exception behavior for JavaScript execution

getJSRunConfigurationTransferErrors

public java.lang.String getJSRunConfigurationTransferErrors()

Returns whether JavaScript execution should transfer errors

setJSRunConfigurationTransferErrors

public void setJSRunConfigurationTransferErrors(java.lang.String connectionName)

Set option to transfer errors in JavaScript

getJSRunConfigurationStopInChrome

public java.lang.String getJSRunConfigurationStopInChrome()

setJSRunConfigurationStopInChrome

public void setJSRunConfigurationStopInChrome(java.lang.String connectionName)

getJSRunConfigurationBrowserExecutable

public java.lang.String getJSRunConfigurationBrowserExecutable()

setJSRunConfigurationBrowserExecutable

public void setJSRunConfigurationBrowserExecutable(java.lang.String connectionName)