org.eclipse.jdt.internal.launching

Class EEVMType

java.lang.Object

org.eclipse.jdt.launching.AbstractVMInstallType

org.eclipse.jdt.internal.launching.EEVMType

All Implemented Interfaces:

IVMInstallType

public class EEVMType
extends AbstractVMInstallType

Utility class for Standard VM type. Used to generate/retrieve information for VMs defined by EE property file.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_EE_VM_TYPE VM Type id
static java.lang.String	VAR_EE_HOME Substitution in EE file - replaced with directory of EE file, to support absolute path names where needed.

Constructor Summary

Constructors

Constructor and Description
EEVMType()

Method Summary

Modifier and Type	Method and Description
java.io.File	detectInstallLocation() Tries to detect an installed VM that matches this VM install type.
protected IVMInstall	doCreateVMInstall(java.lang.String id) Subclasses should return a new instance of the appropriate IVMInstall subclass from this method.
LibraryLocation[]	getDefaultLibraryLocations(java.io.File installLocationOrDefinitionFile) 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.
static java.net.URL	getIndexLocation(java.util.Map<java.lang.String,java.lang.String> properties) Returns the default index location specified in the properties or null if none.
static java.net.URL	getJavadocLocation(java.util.Map<java.lang.String,java.lang.String> properties) Returns the default javadoc location specified in the properties or null if none.
java.lang.String	getName() Returns the display name of this VM type.
static IStatus	validateDefinitionFile(ExecutionEnvironmentDescription description) Returns a status indicating if the given definition file is valid.
IStatus	validateInstallLocation(java.io.File installLocation) Validates the given location of a VM installation.

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

createVMInstall, disposeVMInstall, findVMInstall, findVMInstallByName, getDefaultJavadocLocation, 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_EE_VM_TYPE

public static final java.lang.String ID_EE_VM_TYPE

VM Type id

See Also:

Constant Field Values

VAR_EE_HOME

public static final java.lang.String VAR_EE_HOME

Substitution in EE file - replaced with directory of EE file, to support absolute path names where needed.

See Also:

Constant Field Values

Constructor Detail

EEVMType

public EEVMType()

Method Detail

getJavadocLocation

public static java.net.URL getJavadocLocation(java.util.Map<java.lang.String,java.lang.String> properties)

Returns the default javadoc location specified in the properties or null if none.

Parameters:

properties - properties map

Returns:

javadoc location specified in the properties or null if none

getIndexLocation

public static java.net.URL getIndexLocation(java.util.Map<java.lang.String,java.lang.String> properties)

Returns the default index location specified in the properties or null if none.

Parameters:

properties - properties map

Returns:

index location specified in the properties or null if none

Since:

3.7.0

validateDefinitionFile

public static IStatus validateDefinitionFile(ExecutionEnvironmentDescription description)

Returns a status indicating if the given definition file is valid.

Parameters:

description - definition file

Returns:

status indicating if the given definition file is valid

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.

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.

getDefaultLibraryLocations

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

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:

installLocationOrDefinitionFile - home location

Returns:

default library locations based on the given installLocation.

See Also:

LibraryLocation, IVMInstallType.validateInstallLocation(File)

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

validateInstallLocation

public IStatus validateInstallLocation(java.io.File installLocation)

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:

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

Returns:

a status object describing whether the install location is valid