http://www.eclipse.org/jdt: Java Development Tools Launching Support (Eclipse Foundation) 
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;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaProject;


Resolves variable and/or container runtime classpath entries in
the context of a launch configuration or Java project. A resolver can be declared
as an extension (org.eclipse.jdt.launching.runtimeClasspathEntryResolver),
or be registered with the JavaRuntime programmatically.


A resolver is registered for a specific classpath
VARIABLE and/or CONTAINER. A resolver is
consulted when a runtime classpath entry is needs to be resolved.


A resolver extension is defined in plugin.xml.
Following is an example definition of a runtime classpath entry
resolver extension.

<extension point="org.eclipse.jdt.launching.runtimeClasspathEntryResolvers">
  <runtimeClasspathEntryResolver
     id="com.example.ExampleResolver"
     class="com.example.ExampleResolverImpl"
     variable="VAR_NAME"
     container="CONTAINER_ID"
  </runtimeClasspathEntryResolver>
</extension>


The attributes are specified as follows:

    

  • id specifies a unique identifier for this extension.
    • 

  • class specifies the fully qualified name of the Java class
  that implements IRuntimeClasspathEntryResolver.
    • 

  • variable name of the classpath variable this resolver
	is registered for.
    • 

  • container identifier of the classpath container this
	resolver is registered for.
    • 


At least one of variable or container must be
specified.


Clients may implement this interface.

Since:2.0
/**
 * Resolves variable and/or container runtime classpath entries in
 * the context of a launch configuration or Java project. A resolver can be declared
 * as an extension (<code>org.eclipse.jdt.launching.runtimeClasspathEntryResolver</code>),
 * or be registered with the <code>JavaRuntime</code> programmatically.
 * <p>
 * A resolver is registered for a specific classpath
 * <code>VARIABLE</code> and/or <code>CONTAINER</code>. A resolver is
 * consulted when a runtime classpath entry is needs to be resolved.
 * </p>
 * A resolver extension is defined in <code>plugin.xml</code>.
 * Following is an example definition of a runtime classpath entry
 * resolver extension.
 * <pre>
 * &lt;extension point="org.eclipse.jdt.launching.runtimeClasspathEntryResolvers"&gt;
 *   &lt;runtimeClasspathEntryResolver
 *      id="com.example.ExampleResolver"
 *      class="com.example.ExampleResolverImpl"
 *      variable="VAR_NAME"
 *      container="CONTAINER_ID"
 *   &lt;/runtimeClasspathEntryResolver&gt;
 * &lt;/extension&gt;
 * </pre>
 * The attributes are specified as follows:
 * <ul>
 * <li><code>id</code> specifies a unique identifier for this extension.</li>
 * <li><code>class</code> specifies the fully qualified name of the Java class
 *   that implements <code>IRuntimeClasspathEntryResolver</code>.</li>
 * <li><code>variable</code> name of the classpath variable this resolver
 * 	is registered for.</li>
 * <li><code>container</code> identifier of the classpath container this
 * 	resolver is registered for.</li>
 * </ul>
 * At least one of <code>variable</code> or <code>container</code> must be
 * specified.
 * <p>
 * Clients may implement this interface.
 * @since 2.0
 */
public interface IRuntimeClasspathEntryResolver {

	
Returns resolved runtime classpath entries for the given runtime classpath entry,
in the context of the given launch configuration.

Params:
  • entry – runtime classpath entry to resolve, of type
	VARIABLE or CONTAINTER
  • configuration – the context in which the runtime classpath entry
	needs to be resolved
Throws:
Returns:resolved entries (zero or more)
/**
	 * Returns resolved runtime classpath entries for the given runtime classpath entry,
	 * in the context of the given launch configuration.
	 *
	 * @param entry runtime classpath entry to resolve, of type
	 * 	<code>VARIABLE</code> or <code>CONTAINTER</code>
	 * @param configuration the context in which the runtime classpath entry
	 * 	needs to be resolved
	 * @return resolved entries (zero or more)
	 * @exception CoreException if unable to resolve the entry
	 */
	public IRuntimeClasspathEntry[] resolveRuntimeClasspathEntry(IRuntimeClasspathEntry entry, ILaunchConfiguration configuration) throws CoreException;

	
Returns resolved runtime classpath entries for the given runtime classpath entry,
in the context of the given Java project.

Params:
  • entry – runtime classpath entry to resolve, of type
	VARIABLE or CONTAINTER
  • project – context in which the runtime classpath entry
	needs to be resolved
Throws:
Returns:resolved entries (zero or more)
/**
	 * Returns resolved runtime classpath entries for the given runtime classpath entry,
	 * in the context of the given Java project.
	 *
	 * @param entry runtime classpath entry to resolve, of type
	 * 	<code>VARIABLE</code> or <code>CONTAINTER</code>
	 * @param project context in which the runtime classpath entry
	 * 	needs to be resolved
	 * @return resolved entries (zero or more)
	 * @exception CoreException if unable to resolve the entry
	 */
	public IRuntimeClasspathEntry[] resolveRuntimeClasspathEntry(IRuntimeClasspathEntry entry, IJavaProject project) throws CoreException;

	
Returns resolved runtime classpath entries for the given runtime classpath entry, in the context of the given Java project.

Params:
  • entry – 
           runtime classpath entry to resolve, of type VARIABLE or CONTAINTER
  • project – 
           context in which the runtime classpath entry needs to be resolved
  • excludeTestCode – 
           when true, test code should be excluded
Throws:
Returns:resolved entries (zero or more)
Since:3.10
/**
	 * Returns resolved runtime classpath entries for the given runtime classpath entry, in the context of the given Java project.
	 *
	 * @param entry
	 *            runtime classpath entry to resolve, of type <code>VARIABLE</code> or <code>CONTAINTER</code>
	 * @param project
	 *            context in which the runtime classpath entry needs to be resolved
	 * @param excludeTestCode
	 *            when true, test code should be excluded
	 * @return resolved entries (zero or more)
	 * @exception CoreException
	 *                if unable to resolve the entry
	 * @since 3.10
	 */
	default public IRuntimeClasspathEntry[] resolveRuntimeClasspathEntry(IRuntimeClasspathEntry entry, IJavaProject project, boolean excludeTestCode) throws CoreException {
		return resolveRuntimeClasspathEntry(entry, project);
	}

	
Returns a VM install associated with the given classpath entry, or null if none.

Params:
  • entry – 
           classpath entry
Throws:
Returns:vm install associated with entry or null if none
/**
	 * Returns a VM install associated with the given classpath entry, or <code>null</code> if none.
	 *
	 * @param entry
	 *            classpath entry
	 * @return vm install associated with entry or <code>null</code> if none
	 * @exception CoreException
	 *                if unable to resolve a VM
	 */
	public IVMInstall resolveVMInstall(IClasspathEntry entry) throws CoreException;
}