org.eclipse.jdt.launching/launching/org/eclipse/jdt/launching/environments/IExecutionEnvironmentAnalyzerDelegate.java

/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.launching.environments;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jdt.launching.IVMInstall;

/**
 * Analyzes vm installs for compatibility with execution environments.
 * <p>
 * An execution environment analyzer delegate is contributed in plug-in XML via
 * the <code>org.eclipse.jdt.launching.executionEnvironments</code>
 * extension point.
 * </p>
 * <p>
 * Clients may implement this interface.
 * </p>
 * @since 3.2
 */
public interface IExecutionEnvironmentAnalyzerDelegate {

	/**
	 * Analyzes the given vm install and returns a collection of compatible
	 * execution environments, possibly empty.
	 *
	 * @param vm vm install to analyze
	 * @param monitor progress monitor
	 * @return compatible execution environments, possibly empty
	 * @throws CoreException if an exception occurs analyzing the vm install
	 */
	public CompatibleEnvironment[] analyze(IVMInstall vm, IProgressMonitor monitor) throws CoreException;

}