org.eclipse.jdt.internal.launching

Class VMDefinitionsContainer

java.lang.Object

org.eclipse.jdt.internal.launching.VMDefinitionsContainer

public class VMDefinitionsContainer
extends java.lang.Object

This is a container for VM definitions such as the VM definitions that are stored in the workbench preferences.

An instance of this class may be obtained from an XML document by calling parseXMLIntoContainer.

An instance of this class may be translated into an XML document by calling getAsXML.

Clients may instantiate this class; it is not intended to be subclassed.

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
VMDefinitionsContainer() Constructs an empty VM container

Method Summary

Modifier and Type	Method and Description
void	addVM(IVMInstall vm) Add the specified VM to the VM definitions managed by this container.
void	addVMList(java.util.List<IVMInstall> vmList) Add all VM's in the specified list to the VM definitions managed by this container.
java.lang.String	getAsXML() Return the VM definitions contained in this object as a String of XML.
java.lang.String	getDefaultVMInstallCompositeID() Returns the composite ID for the default VM.
java.lang.String	getDefaultVMInstallConnectorTypeID() Return the default VM's connector type ID.
IStatus	getStatus() Returns status from parsing VM installs or null if none.
java.util.List<IVMInstall>	getValidVMList() Return a list of all valid VMs in this container.
java.util.List<IVMInstall>	getVMList() Return a list of all VMs in this container, including any invalid VMs.
java.util.Map<IVMInstallType,java.util.List<IVMInstall>>	getVMTypeToVMMap() Return a mapping of VM install types to lists of VMs.
static VMDefinitionsContainer	parseXMLIntoContainer(java.io.InputStream inputStream)
static void	parseXMLIntoContainer(java.io.InputStream inputStream, VMDefinitionsContainer container) Parse the VM definitions contained in the specified InputStream into the specified container.
void	removeVM(IVMInstall vm) Removes the VM from this container.
void	setDefaultVMInstallCompositeID(java.lang.String id) Sets the composite ID for the default VM.
void	setDefaultVMInstallConnectorTypeID(java.lang.String id) Set the default VM's connector type ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VMDefinitionsContainer

public VMDefinitionsContainer()

Constructs an empty VM container

Method Detail

addVM

public void addVM(IVMInstall vm)

Add the specified VM to the VM definitions managed by this container.

If distinguishing valid from invalid VMs is important, the specified VM must have already had its install location set. An invalid VM is one whose install location doesn't exist.

Parameters:

vm - the VM to be added to this container

addVMList

public void addVMList(java.util.List<IVMInstall> vmList)

Add all VM's in the specified list to the VM definitions managed by this container.

If distinguishing valid from invalid VMs is important, the specified VMs must have already had their install locations set. An invalid VM is one whose install location doesn't exist.

Parameters:

vmList - a list of VMs to be added to this container

getVMTypeToVMMap

public java.util.Map<IVMInstallType,java.util.List<IVMInstall>> getVMTypeToVMMap()

Return a mapping of VM install types to lists of VMs. The keys of this map are instances of IVMInstallType. The values are instances of java.util.List which contain instances of IVMInstall.

Returns:

Map the mapping of VM install types to lists of VMs

getVMList

public java.util.List<IVMInstall> getVMList()

Return a list of all VMs in this container, including any invalid VMs. An invalid VM is one whose install location does not exist on the file system. The order of the list is not specified.

Returns:

List the data structure containing all VMs managed by this container

getValidVMList

public java.util.List<IVMInstall> getValidVMList()

Return a list of all valid VMs in this container. A valid VM is one whose install location exists on the file system. The order of the list is not specified.

Returns:

List

getDefaultVMInstallCompositeID

public java.lang.String getDefaultVMInstallCompositeID()

Returns the composite ID for the default VM. The composite ID consists of an ID for the VM install type together with an ID for VM. This is necessary because VM ids by themselves are not necessarily unique across VM install types.

Returns:

String returns the composite ID of the current default VM

setDefaultVMInstallCompositeID

public void setDefaultVMInstallCompositeID(java.lang.String id)

Sets the composite ID for the default VM. The composite ID consists of an ID for the VM install type together with an ID for VM. This is necessary because VM ids by themselves are not necessarily unique across VM install types.

Parameters:

id - identifies the new default VM using a composite ID

getDefaultVMInstallConnectorTypeID

public java.lang.String getDefaultVMInstallConnectorTypeID()

Return the default VM's connector type ID.

Returns:

String the current value of the default VM's connector type ID

setDefaultVMInstallConnectorTypeID

public void setDefaultVMInstallConnectorTypeID(java.lang.String id)

Set the default VM's connector type ID.

Parameters:

id - the new value of the default VM's connector type ID

getAsXML

public java.lang.String getAsXML()
                          throws CoreException

Return the VM definitions contained in this object as a String of XML. The String is suitable for storing in the workbench preferences.

The resulting XML is compatible with the static method parseXMLIntoContainer.

Returns:

String the results of flattening this object into XML

Throws:

CoreException - if serialization of the XML document failed

parseXMLIntoContainer

public static VMDefinitionsContainer parseXMLIntoContainer(java.io.InputStream inputStream)
                                                    throws java.io.IOException

Throws:

java.io.IOException

parseXMLIntoContainer

public static void parseXMLIntoContainer(java.io.InputStream inputStream,
                                         VMDefinitionsContainer container)
                                  throws java.io.IOException

Parse the VM definitions contained in the specified InputStream into the specified container.

The VMs in the returned container are instances of VMStandin.

This method has no side-effects. That is, no notifications are sent for VM adds, changes, deletes, and the workbench preferences are not affected.

If the getAsXML method is called on the returned container object, the resulting XML will be semantically equivalent (though not necessarily syntactically equivalent) as the XML contained in inputStream.

Parameters:

inputStream - the InputStream containing XML that declares a set of VMs and a default VM

container - the container to add the VM definitions to

Throws:

java.io.IOException - if this method fails. Reasons include:

• the XML in inputStream was badly formatted
• the top-level node was not 'vmSettings'

Since:

3.2

removeVM

public void removeVM(IVMInstall vm)

Removes the VM from this container.

Parameters:

vm - VM install

getStatus

public IStatus getStatus()

Returns status from parsing VM installs or null if none.

Returns:

status or null