blob: 1e642051a5243fd68c45154d97e5447551dc3a86 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*******************************************************************************
* 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.
* <p>
* A source path computer is contributed in plug-in XML via the
* <code>sourcePathComputers</code> extension point, that provides a delegate
* to compute the path specific to a launch configuration. Following
* is an example contribution.
* <pre>
* <extension point="org.eclipse.debug.core.sourcePathComputers">
* <sourcePathComputer
* id="org.eclipse.example.exampleSourcePathComputer"
* class="org.eclipse.example.SourcePathComputer">
* </sourcePathComputer>
* </extension>
* </pre>
* </p>
* <p>
* A source path computer can be associated with a launch configuration type
* via the <code>sourcePathComputerId</code> attribute of a launch configuration
* type extension. As well, a launch configuration can specify its own
* source path computer to use via the <code>ATTR_SOURCE_PATH_COMPUTER_ID</code>
* attribute.
* </p>
* <p>
* Clients contributing a source path computer provide an implementation of
* {@link org.eclipse.debug.core.sourcelookup.ISourcePathComputerDelegate}.
* </p>
* @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 (<code>null</code>), if the
* default source path computer should be used. A default source path computer
* can be associated with a launch configuration type.
*/
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
*/
String getId();
}
|