Class JavaSourceLocator
- java.lang.Object
-
- org.eclipse.jdt.launching.sourcelookup.JavaSourceLocator
-
- All Implemented Interfaces:
IPersistableSourceLocator
,ISourceLocator
@Deprecated public class JavaSourceLocator extends Object implements IPersistableSourceLocator
Deprecated.In 3.0, the debug platform provides source lookup facilities that should be used in place of the Java source lookup support provided in 2.0. The new facilities provide a source lookup director that coordinates source lookup among a set of participants, searching a set of source containers. See the following packages:org.eclipse.debug.core.sourcelookup
andorg.eclipse.debug.core.sourcelookup.containers
. This class has been replaced by a Java source lookup director and Java source lookup participant. To migrate to the new source lookup support clients should add two new attributes to their launch configuration type extensions:- sourceLocatorId="org.eclipse.jdt.launching.sourceLocator.JavaSourceLookupDirector"
- sourcePathComputerId="org.eclipse.jdt.launching.sourceLookup.javaSourcePathComputer"
ATTR_SOURCE_PATH_PROVIDER
attribute (if present), or a default source lookup path based on a configuration's runtime classpath. This class has been replaced by the Java source lookup director which is an internal class, but can be used via thesourceLocatorId
attribute on a launch configuration type extension.Locates source for a Java debug session by searching a configurable set of source locations.This class may be instantiated.
- Since:
- 2.0
- See Also:
ISourceLocator
- Restriction:
- This class is not intended to be sub-classed by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ID_JAVA_SOURCE_LOCATOR
Deprecated.Identifier for the 'Java Source Locator' extension (value"org.eclipse.jdt.launching.javaSourceLocator"
).
-
Constructor Summary
Constructors Constructor Description JavaSourceLocator()
Deprecated.Constructs a new empty JavaSourceLocator.JavaSourceLocator(IJavaProject project)
Deprecated.Constructs a new JavaSourceLocator that searches the default set of source locations for the given Java project.JavaSourceLocator(IJavaProject[] projects, boolean includeRequired)
Deprecated.Constructs a new Java source locator that looks in the specified project for source, and required projects, ifincludeRequired
istrue
.JavaSourceLocator(IJavaSourceLocation[] locations)
Deprecated.Constructs a new JavaSourceLocator that searches the specified set of source locations for source elements.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected static void
collectRequiredProjects(IJavaProject proj, ArrayList<IJavaProject> res)
Deprecated.Adds all projects required byproj
to the listres
static IJavaSourceLocation[]
getDefaultSourceLocations(IJavaProject project)
Deprecated.Returns a default collection of source locations for the given Java project.String
getMemento()
Deprecated.Object
getSourceElement(IStackFrame stackFrame)
Deprecated.Object[]
getSourceElements(IStackFrame stackFrame)
Deprecated.Returns all source elements that correspond to the type associated with the given stack frame, ornull
if none.IJavaSourceLocation[]
getSourceLocations()
Deprecated.Returns the locations that this source locator is currently searching, in the order that they are searched.void
initializeDefaults(ILaunchConfiguration configuration)
Deprecated.void
initializeFromMemento(String memento)
Deprecated.void
setSourceLocations(IJavaSourceLocation[] locations)
Deprecated.Sets the locations that will be searched, in the order to be searched.
-
-
-
Field Detail
-
ID_JAVA_SOURCE_LOCATOR
public static final String ID_JAVA_SOURCE_LOCATOR
Deprecated.Identifier for the 'Java Source Locator' extension (value"org.eclipse.jdt.launching.javaSourceLocator"
).
-
-
Constructor Detail
-
JavaSourceLocator
public JavaSourceLocator()
Deprecated.Constructs a new empty JavaSourceLocator.
-
JavaSourceLocator
public JavaSourceLocator(IJavaProject[] projects, boolean includeRequired) throws CoreException
Deprecated.Constructs a new Java source locator that looks in the specified project for source, and required projects, ifincludeRequired
istrue
.- Parameters:
projects
- the projects in which to look for sourceincludeRequired
- whether to look in required projects as well- Throws:
CoreException
- if a new locator fails to be created
-
JavaSourceLocator
public JavaSourceLocator(IJavaSourceLocation[] locations)
Deprecated.Constructs a new JavaSourceLocator that searches the specified set of source locations for source elements.- Parameters:
locations
- the source locations to search for source, in the order they should be searched
-
JavaSourceLocator
public JavaSourceLocator(IJavaProject project) throws CoreException
Deprecated.Constructs a new JavaSourceLocator that searches the default set of source locations for the given Java project.- Parameters:
project
- Java project- Throws:
CoreException
- if an exception occurs reading the classpath of the given or any required project
-
-
Method Detail
-
setSourceLocations
public void setSourceLocations(IJavaSourceLocation[] locations)
Deprecated.Sets the locations that will be searched, in the order to be searched.- Parameters:
locations
- the locations that will be searched, in the order to be searched
-
getSourceLocations
public IJavaSourceLocation[] getSourceLocations()
Deprecated.Returns the locations that this source locator is currently searching, in the order that they are searched.- Returns:
- the locations that this source locator is currently searching, in the order that they are searched
-
getSourceElements
public Object[] getSourceElements(IStackFrame stackFrame)
Deprecated.Returns all source elements that correspond to the type associated with the given stack frame, ornull
if none.- Parameters:
stackFrame
- stack frame- Returns:
- all source elements that correspond to the type associated with
the given stack frame, or
null
if none - Since:
- 2.1
-
getSourceElement
public Object getSourceElement(IStackFrame stackFrame)
Deprecated.- Specified by:
getSourceElement
in interfaceISourceLocator
-
collectRequiredProjects
protected static void collectRequiredProjects(IJavaProject proj, ArrayList<IJavaProject> res) throws JavaModelException
Deprecated.Adds all projects required byproj
to the listres
- Parameters:
proj
- the project for which to compute required projectsres
- the list to add all required projects too- Throws:
JavaModelException
- if there is a problem with the backing Java model
-
getDefaultSourceLocations
public static IJavaSourceLocation[] getDefaultSourceLocations(IJavaProject project) throws CoreException
Deprecated.Returns a default collection of source locations for the given Java project. Default source locations consist of the given project and all of its required projects .- Parameters:
project
- Java project- Returns:
- a collection of source locations for all required projects
- Throws:
CoreException
- if an exception occurs reading computing the default locations
-
getMemento
public String getMemento() throws CoreException
Deprecated.- Specified by:
getMemento
in interfaceIPersistableSourceLocator
- Throws:
CoreException
-
initializeDefaults
public void initializeDefaults(ILaunchConfiguration configuration) throws CoreException
Deprecated.- Specified by:
initializeDefaults
in interfaceIPersistableSourceLocator
- Throws:
CoreException
-
initializeFromMemento
public void initializeFromMemento(String memento) throws CoreException
Deprecated.- Specified by:
initializeFromMemento
in interfaceIPersistableSourceLocator
- Throws:
CoreException
-
-