org.eclipse.jdt.internal.launching

Class StandardVMType

java.lang.Object

org.eclipse.jdt.launching.AbstractVMInstallType

org.eclipse.jdt.internal.launching.StandardVMType

All Implemented Interfaces:

IVMInstallType

Direct Known Subclasses:

Standard11xVMType

public class StandardVMType
extends AbstractVMInstallType

A VM install type for VMs the conform to the standard JDK installation layout.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_STANDARD_VM_TYPE
static java.lang.String	MIN_VM_SIZE The minimal -Xmx size for launching a JVM.

Constructor Summary

Constructors

Constructor and Description
StandardVMType()

Method Summary

Modifier and Type	Method and Description
protected boolean	canDetectDefaultSystemLibraries(java.io.File javaHome, java.io.File javaExecutable) Return true if the appropriate system libraries can be found for the specified java executable, false otherwise.
java.io.File	detectInstallLocation() Tries to detect an installed VM that matches this VM install type.
void	disposeVMInstall(java.lang.String id) Remove the VM associated with the given id from the set of VMs managed by this VM type.
protected IVMInstall	doCreateVMInstall(java.lang.String id) Subclasses should return a new instance of the appropriate IVMInstall subclass from this method.
static java.io.File	findJavaExecutable(java.io.File vmInstallLocation) Starting in the specified VM install location, attempt to find the 'java' executable file.
static java.util.List<LibraryLocation>	gatherAllLibraries(java.lang.String[] dirPaths) Returns a list of all zip's and jars contained in the given directories.
protected LibraryInfo	generateLibraryInfo(java.io.File javaHome, java.io.File javaExecutable) Generates library information for the given java executable.
protected java.io.File	getDefaultEndorsedDirectory(java.io.File installLocation) Returns the default location of the endorsed directory, based on the given install location.
protected java.io.File	getDefaultExtensionDirectory(java.io.File installLocation) Returns the default location of the extension directory, based on the given install location.
java.net.URL	getDefaultJavadocLocation(java.io.File installLocation) Returns a URL for the default javadoc location of a VM installed at the given home location, or null if none.
static java.net.URL	getDefaultJavadocLocation(java.lang.String version) Returns a default Javadoc location for a language version, or null.
protected LibraryInfo	getDefaultLibraryInfo(java.io.File installLocation) Returns default library information for the given install location.
LibraryLocation[]	getDefaultLibraryLocations(java.io.File installLocation) Returns a collection of LibraryLocations that represent the default system libraries of this VM install type, if a VM was installed at the given installLocation.
protected IPath	getDefaultPackageRootPath() Returns the package root path
protected java.lang.String	getDefaultRootPath()
protected IPath	getDefaultSystemLibrary(java.io.File javaHome) Return an IPath corresponding to the single library file containing the standard Java classes for most VMs version 1.2 and above.
protected IPath	getDefaultSystemLibrarySource(java.io.File libLocation) Returns a path to the source attachment for the given library, or an empty path if none.
protected java.io.File	getJavaHomeLocation() Returns the VM install location using the java.home system property or null.
protected LibraryInfo	getLibraryInfo(java.io.File javaHome, java.io.File javaExecutable) Return library information corresponding to the specified install location.
java.lang.String	getName() Returns the display name of this VM type.
protected java.lang.String	getVMVersion(java.io.File javaHome, java.io.File javaExecutable) Returns the version of the VM at the given location, with the given executable.
protected LibraryInfo	parseLibraryInfo(IProcess process) Parses the output from 'LibraryDetector'.
protected java.lang.String[]	parsePaths(java.lang.String paths)
java.lang.String	readReleaseVersion(java.io.File javaHome)
protected void	setDefaultRootPath(java.lang.String defaultRootPath)
IStatus	validateInstallLocation(java.io.File javaHome) Validates the given location of a VM installation.

Methods inherited from class org.eclipse.jdt.launching.AbstractVMInstallType

createVMInstall, findVMInstall, findVMInstallByName, getDefaultVMArguments, getId, getVMInstalls, setInitializationData

Methods inherited from class java.lang.Object

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

Field Detail

ID_STANDARD_VM_TYPE

public static final java.lang.String ID_STANDARD_VM_TYPE

See Also:

Constant Field Values

MIN_VM_SIZE

public static final java.lang.String MIN_VM_SIZE

The minimal -Xmx size for launching a JVM.
Note: Must be omitted for Standard11xVM!
Note: Must be at least -Xmx16m for JRockit, see bug 433455.

Since:

3.7.100

See Also:

Constant Field Values

Constructor Detail

StandardVMType

public StandardVMType()

Method Detail

findJavaExecutable

public static java.io.File findJavaExecutable(java.io.File vmInstallLocation)

Starting in the specified VM install location, attempt to find the 'java' executable file. If found, return the corresponding File object, otherwise return null.

Parameters:

vmInstallLocation - the File location to look in

Returns:

the File for the Java executable or null

getName

public java.lang.String getName()

Description copied from interface: IVMInstallType

Returns the display name of this VM type.

Returns:

the name of this IVMInstallType

doCreateVMInstall

protected IVMInstall doCreateVMInstall(java.lang.String id)

Description copied from class: AbstractVMInstallType

Subclasses should return a new instance of the appropriate IVMInstall subclass from this method.

Specified by:

doCreateVMInstall in class AbstractVMInstallType

Parameters:

id - The vm's id. The IVMInstall instance that is created must return id from its getId() method. Must not be null.

Returns:

the newly created IVMInstall instance. Must not return null.

getLibraryInfo

protected LibraryInfo getLibraryInfo(java.io.File javaHome,
                                     java.io.File javaExecutable)

Return library information corresponding to the specified install location. If the information does not exist, create it using the given Java executable.

Parameters:

javaHome - the Java home folder

javaExecutable - the Java executable file

Returns:

the LibraryInfo for the home and executable path or an empty object, never null

canDetectDefaultSystemLibraries

protected boolean canDetectDefaultSystemLibraries(java.io.File javaHome,
                                                  java.io.File javaExecutable)

Return true if the appropriate system libraries can be found for the specified java executable, false otherwise.

Parameters:

javaHome - the Java home folder

javaExecutable - the Java executable file

Returns:

true if the default system libraries can be detected for the given install location false otherwise

getVMVersion

protected java.lang.String getVMVersion(java.io.File javaHome,
                                        java.io.File javaExecutable)

Returns the version of the VM at the given location, with the given executable.

Parameters:

javaHome - the Java home folder

javaExecutable - the Java executable file

Returns:

String

detectInstallLocation

public java.io.File detectInstallLocation()

Description copied from interface: IVMInstallType

Tries to detect an installed VM that matches this VM install type. Typically, this method will detect the VM installation the Eclipse platform runs on. Implementers should return null if they can't assure that a given vm install matches this IVMInstallType.

Returns:

The location of an VM installation that can be used with this VM install type, or null if unable to locate an installed VM.

getJavaHomeLocation

protected java.io.File getJavaHomeLocation()

Returns the VM install location using the java.home system property or null.

Returns:

the install location of this type of VM based off of the java.home system property, or null if not found

Since:

3.7

getDefaultSystemLibrary

protected IPath getDefaultSystemLibrary(java.io.File javaHome)

Return an IPath corresponding to the single library file containing the standard Java classes for most VMs version 1.2 and above.

Parameters:

javaHome - the Java home folder

Returns:

the IPath to the rt.jar file

getDefaultSystemLibrarySource

protected IPath getDefaultSystemLibrarySource(java.io.File libLocation)

Returns a path to the source attachment for the given library, or an empty path if none.

Parameters:

libLocation - the File location of the library to find the source for

Returns:

a path to the source attachment for the given library, or an empty path if none

getDefaultPackageRootPath

protected IPath getDefaultPackageRootPath()

Returns the package root path

Returns:

the package root path

getDefaultLibraryLocations

public LibraryLocation[] getDefaultLibraryLocations(java.io.File installLocation)

Description copied from interface: IVMInstallType

Returns a collection of LibraryLocations that represent the default system libraries of this VM install type, if a VM was installed at the given installLocation. The returned LibraryLocations may not exist if the installLocation is not a valid install location.

Parameters:

installLocation - home location

Returns:

default library locations based on the given installLocation.

See Also:

LibraryLocation, IVMInstallType.validateInstallLocation(File)

getDefaultLibraryInfo

protected LibraryInfo getDefaultLibraryInfo(java.io.File installLocation)

Returns default library information for the given install location.

Parameters:

installLocation - the VM install location

Returns:

LibraryInfo

gatherAllLibraries

public static java.util.List<LibraryLocation> gatherAllLibraries(java.lang.String[] dirPaths)

Returns a list of all zip's and jars contained in the given directories.

Parameters:

dirPaths - a list of absolute paths of directories to search

Returns:

List of all zip's and jars

getDefaultExtensionDirectory

protected java.io.File getDefaultExtensionDirectory(java.io.File installLocation)

Returns the default location of the extension directory, based on the given install location. The resulting file may not exist, or be null if an extension directory is not supported.

Parameters:

installLocation - the VM install location

Returns:

default extension directory or null

getDefaultEndorsedDirectory

protected java.io.File getDefaultEndorsedDirectory(java.io.File installLocation)

Returns the default location of the endorsed directory, based on the given install location. The resulting file may not exist, or be null if an endorsed directory is not supported.

Parameters:

installLocation - the VM install location

Returns:

default endorsed directory or null

getDefaultRootPath

protected java.lang.String getDefaultRootPath()

setDefaultRootPath

protected void setDefaultRootPath(java.lang.String defaultRootPath)

validateInstallLocation

public IStatus validateInstallLocation(java.io.File javaHome)

Description copied from interface: IVMInstallType

Validates the given location of a VM installation.

For example, an implementation might check whether the VM executable is present.

Parameters:

javaHome - the root directory of a potential installation for this type of VM

Returns:

a status object describing whether the install location is valid

generateLibraryInfo

protected LibraryInfo generateLibraryInfo(java.io.File javaHome,
                                          java.io.File javaExecutable)

Generates library information for the given java executable. A main program is run (org.eclipse.jdt.internal.launching.support. LibraryDetector), that dumps the system properties for bootpath and extension directories. This output is then parsed and cached for future reference.

Parameters:

javaHome - the Java home folder

javaExecutable - the Java executable file

Returns:

library info or null if none

parseLibraryInfo

protected LibraryInfo parseLibraryInfo(IProcess process)

Parses the output from 'LibraryDetector'.

Parameters:

process - the backing IProcess that was run

Returns:

the new LibraryInfo object or null

parsePaths

protected java.lang.String[] parsePaths(java.lang.String paths)

disposeVMInstall

public void disposeVMInstall(java.lang.String id)

Description copied from interface: IVMInstallType

Remove the VM associated with the given id from the set of VMs managed by this VM type. Has no effect if a VM with the given id is not currently managed by this type. A VM install that is disposed may not be used anymore.

Specified by:

disposeVMInstall in interface IVMInstallType

Overrides:

disposeVMInstall in class AbstractVMInstallType

Parameters:

id - the id of the VM to be disposed.

getDefaultJavadocLocation

public java.net.URL getDefaultJavadocLocation(java.io.File installLocation)

Description copied from class: AbstractVMInstallType

Returns a URL for the default javadoc location of a VM installed at the given home location, or null if none. The default implementation returns null, subclasses must override as appropriate.

Note, this method would ideally be added to IVMInstallType, but it would have been a breaking API change between 2.0 and 2.1. Thus, it has been added to the abstract base class that VM install types should subclass.

Overrides:

getDefaultJavadocLocation in class AbstractVMInstallType

Parameters:

installLocation - home location

Returns:

default javadoc location or null

getDefaultJavadocLocation

public static java.net.URL getDefaultJavadocLocation(java.lang.String version)

Returns a default Javadoc location for a language version, or null.

Parameters:

version - language version such as "1.4"

Returns:

URL to default Javadoc location, or null

readReleaseVersion

public java.lang.String readReleaseVersion(java.io.File javaHome)