Copyright (c) 2000, 2019 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2019 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.launching;


import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.ILaunchConfiguration;

A classpath provider computes an unresolved classpath for a launch configuration, and resolves classpath entries for a launch configuration. A
classpath provider is defined as an extension of type org.eclipse.jdt.launching.classpathProviders.

A provider is registered with an identifier that can be referenced by a launch configuration. A classpath provider is consulted to compute a
classpath or source lookup path when a launch configuration references a provider in one or both of the following attributes:

ATTR_CLASSPATH_PROVIDER
ATTR_SOURCE_PATH_PROVIDER


A provider extension is defined in plugin.xml. Following is an example definition of a runtime classpath provider extension.
<extension point="org.eclipse.jdt.launching.classpathProviders">
  <classpathProvider>
     id="com.example.ExampleClasspathProvider"
     class="com.example.ExampleClasspathProviderImpl"
  </classpathProvider>
</extension>

The attributes are specified as follows:

id specifies a unique identifier for this extension. This identifier may be used to reference a provider on one of the launch
configuration attributes mentioned above.
class specifies the fully qualified name of the Java class that implements IRuntimeClasspathProvider.


Clients may implement this interface.
Since:
2.0/**
 * A classpath provider computes an unresolved classpath for a launch configuration, and resolves classpath entries for a launch configuration. A
 * classpath provider is defined as an extension of type <code>org.eclipse.jdt.launching.classpathProviders</code>.
 * <p>
 * A provider is registered with an identifier that can be referenced by a launch configuration. A classpath provider is consulted to compute a
 * classpath or source lookup path when a launch configuration references a provider in one or both of the following attributes:
 * <ul>
 * <li><code>ATTR_CLASSPATH_PROVIDER</code></li>
 * <li><code>ATTR_SOURCE_PATH_PROVIDER</code></li>
 * </ul>
 * <p>
 * A provider extension is defined in <code>plugin.xml</code>. Following is an example definition of a runtime classpath provider extension.
 * 
 * <pre>
 * &lt;extension point="org.eclipse.jdt.launching.classpathProviders"&gt;
 *   &lt;classpathProvider&gt;
 *      id="com.example.ExampleClasspathProvider"
 *      class="com.example.ExampleClasspathProviderImpl"
 *   &lt;/classpathProvider&gt;
 * &lt;/extension&gt;
 * </pre>
 * 
 * The attributes are specified as follows:
 * <ul>
 * <li><code>id</code> specifies a unique identifier for this extension. This identifier may be used to reference a provider on one of the launch
 * configuration attributes mentioned above.</li>
 * <li><code>class</code> specifies the fully qualified name of the Java class that implements <code>IRuntimeClasspathProvider</code>.</li>
 * </ul>
 * <p>
 * Clients may implement this interface.
 *
 * @since 2.0
 */
public interface IRuntimeClasspathProvider {

	
Computes and returns an unresolved classpath for the given launch configuration.
Variable and container entries are not resolved.
Params:
configuration – launch configuration
Throws:
CoreException – if unable to compute a path
Returns:
unresolved path/**
	 * Computes and returns an unresolved classpath for the given launch configuration.
	 * Variable and container entries are not resolved.
	 *
	 * @param configuration launch configuration
	 * @return unresolved path
	 * @exception CoreException if unable to compute a path
	 */
	public IRuntimeClasspathEntry[] computeUnresolvedClasspath(ILaunchConfiguration configuration) throws CoreException;

	
Returns the resolved path corresponding to the given path, in the context of the
given launch configuration. Variable and container entries are resolved. The returned
(resolved) path need not have the same number of entries as the given (unresolved)
path.
Params:
entries – entries to resolve
configuration – launch configuration context to resolve in
Throws:
CoreException – if unable to resolve a path
Returns:
resolved path/**
	 * Returns the resolved path corresponding to the given path, in the context of the
	 * given launch configuration. Variable and container entries are resolved. The returned
	 * (resolved) path need not have the same number of entries as the given (unresolved)
	 * path.
	 *
	 * @param entries entries to resolve
	 * @param configuration launch configuration context to resolve in
	 * @return resolved path
	 * @exception CoreException if unable to resolve a path
	 */
	public IRuntimeClasspathEntry[] resolveClasspath(IRuntimeClasspathEntry[] entries, ILaunchConfiguration configuration) throws CoreException;

}