/******************************************************************************* * Copyright (c) 2003, 2008 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.debug.core.sourcelookup; import org.eclipse.debug.core.DebugPlugin; /** * A source path computer computes the default source lookup path (set of source * containers that should be considered) for a launch configuration. *
* A source path computer is contributed in plug-in XML via the
* sourcePathComputers
extension point, that provides a delegate
* to compute the path specific to a launch configuration. Following
* is an example contribution.
*
* <extension point="org.eclipse.debug.core.sourcePathComputers"> * <sourcePathComputer * id="org.eclipse.example.exampleSourcePathComputer" * class="org.eclipse.example.SourcePathComputer"> * </sourcePathComputer> * </extension> ** *
* A source path computer can be associated with a launch configuration type
* via the sourcePathComputerId
attribute of a launch configuration
* type extension. As well, a launch configuration can specify its own
* source path computer to use via the ATTR_SOURCE_PATH_COMPUTER_ID
* attribute.
*
* Clients contributing a source path computer provide an implementation of * {@link org.eclipse.debug.core.sourcelookup.ISourcePathComputerDelegate}. *
* @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. */ public interface ISourcePathComputer extends ISourcePathComputerDelegate { /** * Launch configuration attribute to specify a source path computer * that should be used for a launch configuration. The value is an identifier * of a source path computer extension, or unspecified (null
), if the
* default source path computer should be used. A default source path computer
* can be associated with a launch configuration type.
*/
public static final String ATTR_SOURCE_PATH_COMPUTER_ID = DebugPlugin.getUniqueIdentifier() + ".SOURCE_PATH_COMPUTER_ID"; //$NON-NLS-1$
/**
* Returns the unique identifier for this source path computer.
*
* @return the unique identifier for this source path computer
*/
public String getId();
}