public interface IVMInstall
A VM install is responsible for creating VM runners to launch a Java program in a specific mode.
This interface is intended to be implemented by clients that contribute
to the "org.eclipse.jdt.launching.vmInstallTypes"
extension point.
Rather than implementing this interface directly, it is strongly recommended that
clients subclass AbstractVMInstall
to be insulated
from potential API additions. In 3.1, a new optional interface has been added for
implementors of this interface - IVMInstall2
.
The new interface is implemented by AbstractVMInstall
.
IVMInstall2
Modifier and Type | Method and Description |
---|---|
String |
getId()
Returns the id for this VM.
|
File |
getInstallLocation()
Returns the root directory of the install location of this VM.
|
URL |
getJavadocLocation()
Returns the Javadoc location associated with this VM install.
|
LibraryLocation[] |
getLibraryLocations()
Returns the library locations of this IVMInstall.
|
String |
getName()
Returns the display name of this VM.
|
String[] |
getVMArguments()
Returns VM arguments to be used with this vm install whenever this
VM is launched as they should be passed to the command line, or
null if none. |
IVMInstallType |
getVMInstallType()
Returns the VM type of this VM.
|
IVMRunner |
getVMRunner(String mode)
Returns a VM runner that runs this installed VM in the given mode.
|
void |
setInstallLocation(File installLocation)
Sets the root directory of the install location of this VM.
|
void |
setJavadocLocation(URL url)
Sets the Javadoc location associated with this VM install.
|
void |
setLibraryLocations(LibraryLocation[] locations)
Sets the library locations of this IVMInstall.
|
void |
setName(String name)
Sets the display name of this VM.
|
void |
setVMArguments(String[] vmArgs)
Deprecated.
if possible, clients should use setVMArgs(String) on
IVMInstall2 when possible |
IVMRunner getVMRunner(String mode)
mode
- the mode the VM should be launched in; one of the constants
declared in org.eclipse.debug.core.ILaunchManager
null
if the given mode
is not supported by this VM.ILaunchManager
String getId()
null
.String getName()
null
.void setName(String name)
name
- the display name of this VMFile getInstallLocation()
null
.void setInstallLocation(File installLocation)
installLocation
- the root directory of this VM installationIVMInstallType getVMInstallType()
LibraryLocation[] getLibraryLocations()
JavaRuntime.getLibraryLocations(IVMInstall)
to determine the libraries associated with this VM install.null
to indicate that this VM install uses
the default library locations associated with this VM's install type.setLibraryLocations(LibraryLocation[])
void setLibraryLocations(LibraryLocation[] locations)
locations
- The LibraryLocation
s to associate
with this IVMInstall.
May be null
to indicate that this VM install uses
the default library locations associated with this VM's install type.void setJavadocLocation(URL url)
url
- a url pointing to the Javadoc location associated with
this VM installURL getJavadocLocation()
null
if noneString[] getVMArguments()
null
if none.null
if none@Deprecated void setVMArguments(String[] vmArgs)
IVMInstall2
when possiblenull
. This is equivalent
to setVMArgs(String)
with whitespace character delimited
arguments.vmArgs
- VM arguments to be used with this vm install whenever this
VM is launched, possibly null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.