Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.jdt.launching
Interface IVMInstall  view IVMInstall download IVMInstall.java

All Known Implementing Classes:
AbstractVMInstall

public interface IVMInstall

Represents a particular installation of a VM. A VM instance holds all parameters specific to a VM installation. Unlike VM types, VM instances can be created and configured dynamically at run-time. This is typically done by the user interactively in the UI.

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.vmType" extension point.


Method Summary
 java.lang.String getId()
          Returns the id for this VM.
 java.io.File getInstallLocation()
          Returns the root directory of the install location of this VM.
 java.net.URL getJavadocLocation()
          Returns the Javadoc location associated with this VM install.
 LibraryLocation[] getLibraryLocations()
          Returns the library locations of this IVMInstall.
 java.lang.String getName()
          Returns the display name of this VM.
 java.lang.String[] getVMArguments()
          Returns VM arguments to be used with this vm install whenever this VM is launched, or null if none.
 IVMInstallType getVMInstallType()
          Returns the VM type of this VM.
 IVMRunner getVMRunner(java.lang.String mode)
          Returns a VM runner that runs this installed VM in the given mode.
 void setInstallLocation(java.io.File installLocation)
          Sets the root directory of the install location of this VM.
 void setJavadocLocation(java.net.URL url)
          Sets the Javadoc location associated with this VM install.
 void setLibraryLocations(LibraryLocation[] locations)
          Sets the library locations of this IVMInstall.
 void setName(java.lang.String name)
          Sets the display name of this VM.
 void setVMArguments(java.lang.String[] vmArgs)
          Sets VM arguments to be used with this vm install whenever this VM is launched, possibly null.
 

Method Detail

getVMRunner

public IVMRunner getVMRunner(java.lang.String mode)
Returns a VM runner that runs this installed VM in the given mode.


getId

public java.lang.String getId()
Returns the id for this VM. VM ids are unique within the VMs of a given VM type. The VM id is not intended to be presented to users.


getName

public java.lang.String getName()
Returns the display name of this VM. The VM name is intended to be presented to users.


setName

public void setName(java.lang.String name)
Sets the display name of this VM. The VM name is intended to be presented to users.


getInstallLocation

public java.io.File getInstallLocation()
Returns the root directory of the install location of this VM.


setInstallLocation

public void setInstallLocation(java.io.File installLocation)
Sets the root directory of the install location of this VM.


getVMInstallType

public IVMInstallType getVMInstallType()
Returns the VM type of this VM.


getLibraryLocations

public LibraryLocation[] getLibraryLocations()
Returns the library locations of this IVMInstall. Generally, clients should use JavaRuntime.getLibraryLocations(IVMInstall) to determine the libraries associated with this VM install.

Since:
2.0

setLibraryLocations

public void setLibraryLocations(LibraryLocation[] locations)
Sets the library locations of this IVMInstall.

Since:
2.0

setJavadocLocation

public void setJavadocLocation(java.net.URL url)
Sets the Javadoc location associated with this VM install.

Since:
2.0

getJavadocLocation

public java.net.URL getJavadocLocation()
Returns the Javadoc location associated with this VM install.

Since:
2.0

getVMArguments

public java.lang.String[] getVMArguments()
Returns VM arguments to be used with this vm install whenever this VM is launched, or null if none.

Since:
3.0

setVMArguments

public void setVMArguments(java.lang.String[] vmArgs)
Sets VM arguments to be used with this vm install whenever this VM is launched, possibly null.

Since:
3.0