oracle.jdeveloper.runner

Class JStarter

java.lang.Object

oracle.ide.runner.Starter

oracle.jdeveloper.runner.JStarter

public class JStarter
extends Starter

A class that represents a way of starting a Java process.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAVA_ARCH_DATA_MODEL
static java.lang.String	JAVA_HOME
static java.lang.String	JAVA_VERSION
protected JRunProcess	jrunProcess The JRunProcess that will be or has been started by this JStarter.
protected RunConfiguration	runConfiguration The RunConfiguration part of the project.
protected java.lang.String[]	target The target items for the java command line.

Fields inherited from class oracle.ide.runner.Starter

process, runProcess, startException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JStarter(JRunProcess jrunProcess, java.lang.String[] target) This constructor initializes fields, including jrunProcess, target and runConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addArrayToList(java.util.List list, java.lang.String[] a)
protected void	addBootClassPathOption(java.util.List list)
protected void	addClassPathOption(java.util.List list)
protected void	addEndorsedDirsOption(java.util.List list)
protected void	addFirstJavaCommandOptions(java.util.List list) Prepends the JRunProcess.JAVA_FIRST_COMMAND_OPTIONS to the provided list
protected boolean	addJavaExecutableName(java.util.List list) Adds the Java executable name to the list of command line items.
static void	addJavaOptionProvider(JavaOptionProvider javaOptionProvider) Adds the JavaOptionProvider to the list of JavaOptionProviders that will be called when a Java run process is started.
protected void	addJavaOptionProvidersJavaOptions(java.util.List list) Adds the Java options from the Java option providers to the list of command line items.
protected void	addJavaOptions(java.util.List list) Adds the Java options to the list of command line items.
protected boolean	addJavaVmOption(java.util.List list) Adds the Java VM option to the list of command line items.
protected void	addLastJavaCommandOptions(java.util.List list)
protected void	addProgramArguments(java.util.List list) Adds the program arguments to the list of command line items.
protected void	addProxyJavaOptions(java.util.List list) Adds the proxy options to the list of command line, if the RunConfiguration specifies to pass proxy options to the process.
protected void	addRunConfigurationJavaOptions(java.util.List list) Adds the Java options specified in the RunConfiguration to the list of command line items.
protected java.lang.String	getBootClassPath() Returns the boot class path.
protected java.lang.String	getClassPath() Returns the class path.
protected JRunProcess.CompilationScope	getCompilationScope()
protected Element[]	getExplicitCompilationTargets()
java.lang.String	getJdkSystemProperty(java.lang.String key) Return selected system properties for the JDK that will be used to start the process.
java.lang.String[]	getStartCommand() Returns the command line that will be executed to start the process.
protected java.lang.String	getVMName() Return the name of the VM that will be used to start the process
static void	removeJavaOptionProvider(JavaOptionProvider javaOptionProvider) Removes the JavaOptionProvider from the list of JavaOptionProviders that will be called when a Java run process is started.
protected void	setExplicitCompilationTargets(Element[] targets)
boolean	start() Starts the process.

Methods inherited from class oracle.ide.runner.Starter

canContainRunProcesses, canStart, canTerminate, canTerminateGracefully, finished, getExitCode, getProcess, getStartDirectory, getStartEnvironmentParams, getStartException, getTerminateCommand, getTerminateEnvironmentParams, isStartOnly, mustPrepareToStart, prepareToStart, reuseLogPage, terminate, terminateGracefully, waitForProcess

Methods inherited from class java.lang.Object

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

Field Detail

jrunProcess

protected JRunProcess jrunProcess

The JRunProcess that will be or has been started by this JStarter.

target

protected java.lang.String[] target

The target items for the java command line.

runConfiguration

protected RunConfiguration runConfiguration

The RunConfiguration part of the project.

JAVA_HOME

public static final java.lang.String JAVA_HOME

See Also:

Constant Field Values

JAVA_VERSION

public static final java.lang.String JAVA_VERSION

See Also:

Constant Field Values

JAVA_ARCH_DATA_MODEL

public static final java.lang.String JAVA_ARCH_DATA_MODEL

See Also:

Constant Field Values

Constructor Detail

JStarter

protected JStarter(JRunProcess jrunProcess,
        java.lang.String[] target)

This constructor initializes fields, including jrunProcess, target and runConfiguration.

Method Detail

addJavaOptionProvider

public static void addJavaOptionProvider(JavaOptionProvider javaOptionProvider)

Adds the JavaOptionProvider to the list of JavaOptionProviders that will be called when a Java run process is started.

removeJavaOptionProvider

public static void removeJavaOptionProvider(JavaOptionProvider javaOptionProvider)

Removes the JavaOptionProvider from the list of JavaOptionProviders that will be called when a Java run process is started.

getStartCommand

public java.lang.String[] getStartCommand()

Returns the command line that will be executed to start the process.

Overrides:

getStartCommand in class Starter

Returns:

the command line

start

public boolean start()

Description copied from class: Starter

Starts the process.

After the process is started, it calls the RunProcess.redirectOutput(java.io.InputStream, java.io.InputStream) method with the standard output and error streams and the RunProcess.redirectInput(java.io.OutputStream) method with the standard input stream.

Overrides:

start in class Starter

Returns:

true if the process was started.

addJavaExecutableName

protected boolean addJavaExecutableName(java.util.List list)

Adds the Java executable name to the list of command line items.

Parameters:

list - the command line items so far

Returns:

true if the Java executable name can be determined.

addJavaVmOption

protected boolean addJavaVmOption(java.util.List list)

Adds the Java VM option to the list of command line items.

The Java VM is specified by the RunConfiguration

The implementation here asks each JavaOptionProviders for the Java VM name. Any of the JavaOptionProviders are allowed to change the VM name and the last one sticks.

Parameters:

list - the command line items so far

Returns:

true

getVMName

protected final java.lang.String getVMName()

Return the name of the VM that will be used to start the process

addFirstJavaCommandOptions

protected final void addFirstJavaCommandOptions(java.util.List list)

Prepends the JRunProcess.JAVA_FIRST_COMMAND_OPTIONS to the provided list

Parameters:

list - the command line items so far

addJavaOptions

protected void addJavaOptions(java.util.List list)

Adds the Java options to the list of command line items.

The implementation here adds the Java options specified in the RunConfiguration, the Java options from JavaOptionProviders, and if the RunConfiguration specifies to pass proxy options to the process, these are also added.

Parameters:

list - the command line items so far

addRunConfigurationJavaOptions

protected void addRunConfigurationJavaOptions(java.util.List list)

Adds the Java options specified in the RunConfiguration to the list of command line items.

Parameters:

list - the command line items so far

addJavaOptionProvidersJavaOptions

protected void addJavaOptionProvidersJavaOptions(java.util.List list)

Adds the Java options from the Java option providers to the list of command line items.

Parameters:

list - the command line items so far

addProxyJavaOptions

protected void addProxyJavaOptions(java.util.List list)

Adds the proxy options to the list of command line, if the RunConfiguration specifies to pass proxy options to the process.

Parameters:

list - the command line items so far

addClassPathOption

protected final void addClassPathOption(java.util.List list)

getClassPath

protected java.lang.String getClassPath()

Returns the class path.

addBootClassPathOption

protected final void addBootClassPathOption(java.util.List list)

addEndorsedDirsOption

protected final void addEndorsedDirsOption(java.util.List list)

getBootClassPath

protected java.lang.String getBootClassPath()

Returns the boot class path.

addLastJavaCommandOptions

protected final void addLastJavaCommandOptions(java.util.List list)

addProgramArguments

protected void addProgramArguments(java.util.List list)

Adds the program arguments to the list of command line items.

The implementation here adds program arguments specified in the RunConfiguration and the program arguments from JavaOptionProviders.

Parameters:

list - the command line items so far

addArrayToList

protected static void addArrayToList(java.util.List list,
                  java.lang.String[] a)

getCompilationScope

protected JRunProcess.CompilationScope getCompilationScope()

getExplicitCompilationTargets

protected Element[] getExplicitCompilationTargets()

setExplicitCompilationTargets

protected void setExplicitCompilationTargets(Element[] targets)

getJdkSystemProperty

public java.lang.String getJdkSystemProperty(java.lang.String key)

Return selected system properties for the JDK that will be used to start the process. This method may be overridden by specific starters. The information returned need not be obtained from system properties, per se, as long as it reflects what would be returned for a system property in the running JVM.

Parameters:

key - one of JAVA_HOME, JAVA_VERSION or JAVA_ARCH_DATA_MODEL

Returns:

system property value or null if not found