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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.internal.core.sourcelookup;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.model.IStackFrame;
/**
* A source lookup director directs the source lookup process
* among a set of participants and source containers.
*
* @since 3.0
*/
public interface ISourceLookupDirector extends IPersistableSourceLocator2 {
/**
* Returns the launch configuration associated with this source
* lookup director, or <code>null</code> if none.
*
* @return the launch configuration associated with this source
* lookup director, or <code>null</code> if none
*/
public ILaunchConfiguration getLaunchConfiguration();
/**
* Returns the source lookup participants currently registered with
* this director, possibly an empty collection.
*
* @return the source lookup participants currently registered with
* this director, possibly an empty collection
*/
public ISourceLookupParticipant[] getParticipants();
/**
* Returns the source containers currently registered with this
* director, possibly an empty collection.
*
* @return the source containers currently registered with this
* director, possibly an empty collection
*/
public ISourceContainer[] getSourceContainers();
/**
* Sets the source containers this source lookup director
* should search when looking for source, possibly an empty collection.
*
* @param containers the source containers this source lookup director
* should search when looking for source, possibly an empty collection
*/
public void setSourceContainers(ISourceContainer[] containers);
/**
* Returns whether to search exhaustively for all source elements
* with the same name in all registered source containers, or
* whether to stop searching when the first source element matching
* the required name is found.
*
* @return whether to search exhaustively for all source elements
* with the same name
*/
public boolean isFindDuplicates();
/**
* Sets whether to search exhaustively for all source elements
* with the same name in all registered source containers, or
* whether to stop searching when the first source element matching
* the required name is found.
*
* @param findDuplicates whether to search exhaustively for all source elements
* with the same name
*/
public void setFindDuplicates(boolean findDuplicates);
/**
* Notifies this source lookup director that it should initialize
* its set of source lookup participants.
*/
public void initializeParticipants();
/**
* Returns whether this source director supports the given type
* of source location.
*
* @param type source container type
* @return whether this source director supports the given type
* of source location
*/
public boolean supportsSourceContainerType(ISourceContainerType type);
/**
* Clears any source lookup results associated with the given
* stack frame, such that a subsequent lookup will force a new search
* to be performed.
*
* @param frame stack frame to clear source lookup results for
*/
public void clearSourceElements(IStackFrame frame);
}
|
