|
Eclipse JDT Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jdt.launching.AbstractVMInstall
public abstract class AbstractVMInstall
Abstract implementation of a VM install.
Clients implementing VM installs must subclass this class.
| Constructor Summary | |
|---|---|
AbstractVMInstall(IVMInstallType type,
String id)
Constructs a new VM install. |
|
| Method Summary | |
|---|---|
protected void |
abort(String message,
Throwable exception,
int code)
Throws a core exception with an error status object built from the given message, lower level exception, and error code. |
boolean |
equals(Object object)
|
Map |
evaluateSystemProperties(String[] properties,
IProgressMonitor monitor)
Evaluates the specified system properties in this VM, returning the result as a map of property names to property values. |
String |
getAttribute(String key)
Returns a VM specific attribute associated with the given key or null
if none. |
Map |
getAttributes()
Returns a map of VM specific attributes stored with this VM install. |
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. |
String |
getJavaVersion()
Returns a string representing the java.version system property
of this VM install, or null if unknown. |
LibraryLocation[] |
getLibraryLocations()
Returns the library locations of this IVMInstall. |
String |
getName()
Returns the display name of this VM. |
String |
getVMArgs()
Returns VM arguments to be used with this vm install whenever this VM is launched as a raw string, or null if none. |
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. |
int |
hashCode()
|
void |
setAttribute(String key,
String value)
Sets a VM specific attribute. |
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. |
protected void |
setNotify(boolean notify)
Whether this VM should fire property change notifications. |
void |
setVMArgs(String vmArgs)
Sets VM arguments to be used with this vm install whenever this VM is launched as a raw string, possibly null. |
void |
setVMArguments(String[] vmArgs)
Sets VM arguments to be used with this vm install whenever this VM is launched, possibly null. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractVMInstall(IVMInstallType type,
String id)
type - The type of this VM install.
Must not be nullid - The unique identifier of this VM instance
Must not be null.
IllegalArgumentException - if any of the required
parameters are null.| Method Detail |
|---|
public String getId()
IVMInstall
getId in interface IVMInstallnull.public String getName()
IVMInstall
getName in interface IVMInstallnull.public void setName(String name)
IVMInstall
setName in interface IVMInstallname - the display name of this VMpublic File getInstallLocation()
IVMInstall
getInstallLocation in interface IVMInstallnull.public void setInstallLocation(File installLocation)
IVMInstall
setInstallLocation in interface IVMInstallinstallLocation - the root directory of this VM installationpublic IVMInstallType getVMInstallType()
IVMInstall
getVMInstallType in interface IVMInstallpublic IVMRunner getVMRunner(String mode)
IVMInstall
getVMRunner in interface IVMInstallmode - 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.ILaunchManagerpublic LibraryLocation[] getLibraryLocations()
IVMInstallJavaRuntime.getLibraryLocations(IVMInstall)
to determine the libraries associated with this VM install.
getLibraryLocations in interface IVMInstallnull to indicate that this VM install uses
the default library locations associated with this VM's install type.IVMInstall.setLibraryLocations(LibraryLocation[])public void setLibraryLocations(LibraryLocation[] locations)
IVMInstall
setLibraryLocations in interface IVMInstalllocations - The LibraryLocations 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.public URL getJavadocLocation()
IVMInstall
getJavadocLocation in interface IVMInstallnull if nonepublic void setJavadocLocation(URL url)
IVMInstall
setJavadocLocation in interface IVMInstallurl - a url pointing to the Javadoc location associated with
this VM installprotected void setNotify(boolean notify)
notify - if this VM should fire property change notifications.public boolean equals(Object object)
equals in class Objectpublic int hashCode()
hashCode in class Objectpublic String[] getVMArguments()
IVMInstallnull if none.
getVMArguments in interface IVMInstallnull if nonepublic void setVMArguments(String[] vmArgs)
IVMInstallnull. This is equivalent
to setVMArgs(String) with whitespace character delimited
arguments.
setVMArguments in interface IVMInstallvmArgs - VM arguments to be used with this vm install whenever this
VM is launched, possibly nullpublic String getVMArgs()
IVMInstall2null if none.
getVMArgs in interface IVMInstall2null if nonepublic void setVMArgs(String vmArgs)
IVMInstall2null.
setVMArgs in interface IVMInstall2vmArgs - VM arguments to be used with this vm install whenever this
VM is launched as a raw string, possibly nullpublic String getJavaVersion()
IVMInstall2java.version system property
of this VM install, or null if unknown.
getJavaVersion in interface IVMInstall2java.version system property
of this VM install, or null if unknown.
public Map evaluateSystemProperties(String[] properties,
IProgressMonitor monitor)
throws CoreException
IVMInstall3
evaluateSystemProperties in interface IVMInstall3properties - the property names to evaluate, for example {"user.home"}monitor - progress monitor or null
CoreException - if an exception occurs evaluating the properties
protected void abort(String message,
Throwable exception,
int code)
throws CoreException
message - the status messageexception - lower level exception associated with the error, or
null if nonecode - error code
CoreException - the "abort" core exception
public void setAttribute(String key,
String value)
null as a value removes the attribute. Change
notification is provided to IVMInstallChangedListener for VM attributes.
key - attribute key, cannot be nullvalue - attribute value or null to remove the attributepublic String getAttribute(String key)
null
if none.
key - attribute key, cannot be null
null if nonepublic Map getAttributes()
|
Eclipse JDT Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2011 IBM Corporation and others. All rights reserved.