org.eclipse.ptp.ems.core

Interface IEnvManager2

All Superinterfaces:

IEnvManager

All Known Implementing Classes:

LazyEnvManagerDetector

public interface IEnvManager2
extends IEnvManager

Extension to IEnvManager providing a second implementation of determineAvailableElements(IProgressMonitor, List) that allows the list of selected modules to be passed to the method to determine available modules.

This allows EMS to support nested modules (Bug 405413) by allowing the selected modules to be loaded before running

 module avail
 

.

Since:

3.1

Field Summary

Fields inherited from interface org.eclipse.ptp.ems.core.IEnvManager

ENV_MANAGER_EXTENSION_POINT_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	determineAvailableElements(org.eclipse.core.runtime.IProgressMonitor pm, java.util.List<java.lang.String> selectedElements) Returns the set of all environment configuration elements available on the remote machine (e.g., the result of module -t avail).

Methods inherited from interface org.eclipse.ptp.ems.core.IEnvManager

checkForCompatibleInstallation, configure, createBashScript, determineAvailableElements, determineDefaultElements, getBashConcatenation, getComparator, getDescription, getInstructions, getName

Method Detail

determineAvailableElements

java.util.List<java.lang.String> determineAvailableElements(org.eclipse.core.runtime.IProgressMonitor pm,
                                                            java.util.List<java.lang.String> selectedElements)
                                                     throws RemoteConnectionException,
                                                            java.io.IOException

Returns the set of all environment configuration elements available on the remote machine (e.g., the result of module -t avail).

Parameters:

pm - progress monitor used to report the status of potentially long-running operations to the user (non- null)

selectedElements - elements selected for inclusion (non-null)

Returns:

unmodifiable Set (non-null)

Throws:

java.lang.NullPointerException - if IEnvManager.configure(IRemoteConnection) has not been called

RemoteConnectionException - if an remote connection error occurs

java.io.IOException - if an input/output error occurs

Since:

2.0