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

Quick Search    Search Deep

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

All Known Implementing Classes:
AbstractVMInstallType

public interface IVMInstallType

Represents a particular type of VM for which there may be any number of VM installations. An example of a VM type is the standard JRE which might have instances corresponding to different installed versions such as JRE 1.2.2 and JRE 1.3.

This interface is intended to be implemented by clients that contribute to the "org.eclipse.jdt.launching.vmType" extension point.


Method Summary
 IVMInstall createVMInstall(java.lang.String id)
          Creates a new instance of this VM Install type.
 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.
 IVMInstall findVMInstall(java.lang.String id)
          Finds the VM with the given id.
 IVMInstall findVMInstallByName(java.lang.String name)
          Finds the VM with the given name.
 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.
 java.lang.String getId()
          Returns the globally unique id of this VM type.
 java.lang.String getName()
          Returns the display name of this VM type.
 IVMInstall[] getVMInstalls()
          Returns all VM instances managed by this VM type.
 org.eclipse.core.runtime.IStatus validateInstallLocation(java.io.File installLocation)
          Validates the given location of a VM installation.
 

Method Detail

createVMInstall

public IVMInstall createVMInstall(java.lang.String id)
Creates a new instance of this VM Install type. The newly created IVMInstall is managed by this IVMInstallType.


findVMInstall

public IVMInstall findVMInstall(java.lang.String id)
Finds the VM with the given id.


findVMInstallByName

public IVMInstall findVMInstallByName(java.lang.String name)
Finds the VM with the given name.

Since:
2.0

disposeVMInstall

public void disposeVMInstall(java.lang.String id)
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.


getVMInstalls

public IVMInstall[] getVMInstalls()
Returns all VM instances managed by this VM type.


getName

public java.lang.String getName()
Returns the display name of this VM type.


getId

public java.lang.String getId()
Returns the globally unique id of this VM type. Clients are reponsible for providing a unique id.


validateInstallLocation

public org.eclipse.core.runtime.IStatus validateInstallLocation(java.io.File installLocation)
Validates the given location of a VM installation.

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


detectInstallLocation

public java.io.File detectInstallLocation()
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.


getDefaultLibraryLocations

public 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. The returned LibraryLocations may not exist if the installLocation is not a valid install location.

Since:
2.0