Copyright (c) 2000, 2018 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, 2018 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.w3c.dom.Element;

Enhancements to IRuntimeClasspathEntry to support
extensible runtime classpath entries. Contributed runtime classpath
entries have a type of OTHER, and are contributed to
the runtimeClasspathEntries extension point.

New types of runtime classpath entries are only intended to be contributed
by the Java debugger.

See Also:
IRuntimeClasspathEntry
Since:
3.0
@noimplement
This interface is not intended to be implemented by clients.
@noextend
This interface is not intended to be extended by clients./**
 * Enhancements to <code>IRuntimeClasspathEntry</code> to support
 * extensible runtime classpath entries. Contributed runtime classpath
 * entries have a type of <code>OTHER</code>, and are contributed to
 * the <code>runtimeClasspathEntries</code> extension point.
 * <p>
 * New types of runtime classpath entries are only intended to be contributed
 * by the Java debugger.
 * </p>
 * @since 3.0
 * @see org.eclipse.jdt.launching.IRuntimeClasspathEntry
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IRuntimeClasspathEntry2 extends IRuntimeClasspathEntry {

	
Initializes this runtime classpath entry from the given memento.
Params:
memento – memento created by a classpath entry of the same type
Throws:
CoreException – if unable to initialize from the given memento/**
	 * Initializes this runtime classpath entry from the given memento.
	 *
	 * @param memento memento created by a classpath entry of the same type
	 * @throws CoreException if unable to initialize from the given memento
	 */
	public void initializeFrom(Element memento) throws CoreException;

	
Returns the unique identifier of the extension that contributed
this classpath entry type, or null if this classpath
entry type was not contributed.
Returns:
the unique identifier of the extension that contributed
 this classpath entry type, or null if this classpath
 entry type was not contributed/**
	 * Returns the unique identifier of the extension that contributed
	 * this classpath entry type, or <code>null</code> if this classpath
	 * entry type was not contributed.
	 *
	 * @return the unique identifier of the extension that contributed
	 *  this classpath entry type, or <code>null</code> if this classpath
	 *  entry type was not contributed
	 */
	public String getTypeId();

	
Returns whether this classpath entry is composed of other entries.
Returns:
whether this classpath entry is composed of other entries/**
	 * Returns whether this classpath entry is composed of other entries.
	 *
	 * @return whether this classpath entry is composed of other entries
	 */
	public boolean isComposite();

	
Returns the classpath entries this entry is composed of, or an
empty collection if this entry is not a composite entry.
Params:
configuration – the context (launch configuration) in which
 this runtime classpath entry is being queried for contained
	entries, possibly null
Throws:
CoreException – if unable to retrieve contained entries
Returns:
the classpath entries this entry is composed of, or an
empty collection if this entry is not a composite entry/**
	 * Returns the classpath entries this entry is composed of, or an
	 * empty collection if this entry is not a composite entry.
	 *
	 * @param configuration the context (launch configuration) in which
	 *  this runtime classpath entry is being queried for contained
	 * 	entries, possibly <code>null</code>
	 * @return the classpath entries this entry is composed of, or an
	 * empty collection if this entry is not a composite entry
	 * @throws CoreException if unable to retrieve contained entries
	 */
	public IRuntimeClasspathEntry[] getRuntimeClasspathEntries(ILaunchConfiguration configuration) throws CoreException;

	
Returns the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry.
Params:
excludeTestCode – 
           true, if test code should be excluded
Throws:
CoreException – 
            if unable to retrieve contained entries
Returns:
the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry
Since:
3.10/**
	 * Returns the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry.
	 *
	 * @param excludeTestCode
	 *            true, if test code should be excluded
	 * @return the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry
	 * @throws CoreException
	 *             if unable to retrieve contained entries
	 * @since 3.10
	 */
	default public IRuntimeClasspathEntry[] getRuntimeClasspathEntries(boolean excludeTestCode) throws CoreException {
		return getRuntimeClasspathEntries(null);
	}

	
Returns a human readable name for this classpath entry.
Returns:
a human readable name for this classpath entry/**
	 * Returns a human readable name for this classpath entry.
	 *
	 * @return a human readable name for this classpath entry
	 */
	public String getName();
}