Eclipse JDT
2.1

org.eclipse.jdt.debug.ui
Class JavaUISourceLocator

java.lang.Object
  |
  +--org.eclipse.jdt.debug.ui.JavaUISourceLocator
All Implemented Interfaces:
IPersistableSourceLocator, ISourceLocator

public class JavaUISourceLocator
extends Object
implements IPersistableSourceLocator

A source locator that prompts the user to find source when source cannot be found on the current source lookup path.

This class is intended to be instantiated. This class is not intended to be subclassed.

Since:
2.0

Field Summary
static String ATTR_FIND_ALL_SOURCE_ELEMENTS
          Launch configuration attribute indicating that this source locator should locate all source elements that correspond to a stack frame, rather than the first match.
static String ID_PROMPTING_JAVA_SOURCE_LOCATOR
          Identifier for the 'Prompting Java Source Locator' extension (value "org.eclipse.jdt.debug.ui.javaSourceLocator").
 
Constructor Summary
JavaUISourceLocator()
          Constructs an empty source locator.
JavaUISourceLocator(IJavaProject project)
          Constructs a source locator that searches for source in the given Java project, and all of its required projects, as specified by its build path or default source lookup settings.
JavaUISourceLocator(IJavaProject[] projects, boolean includeRequired)
          Constructs a new source locator that looks in the specified project for source, and required projects, if includeRequired is true.
 
Method Summary
 String getMemento()
           
 Object getSourceElement(IStackFrame stackFrame)
           
 IJavaSourceLocation[] getSourceLocations()
           
 void initializeDefaults(ILaunchConfiguration configuration)
           
 void initializeFromMemento(String memento)
           
 boolean isFindAllSourceElements()
          Returns whether this source locator is configured to search for all source elements that correspond to a stack frame.
 void setFindAllSourceElement(boolean findAll)
          Sets whether this source locator is configured to search for all source elements that correspond to a stack frame, or the first match.
 void setSourceLocations(IJavaSourceLocation[] locations)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID_PROMPTING_JAVA_SOURCE_LOCATOR

public static final String ID_PROMPTING_JAVA_SOURCE_LOCATOR
Identifier for the 'Prompting Java Source Locator' extension (value "org.eclipse.jdt.debug.ui.javaSourceLocator").

ATTR_FIND_ALL_SOURCE_ELEMENTS

public static final String ATTR_FIND_ALL_SOURCE_ELEMENTS
Launch configuration attribute indicating that this source locator should locate all source elements that correspond to a stack frame, rather than the first match. Default value is false.
Since:
2.1
Constructor Detail

JavaUISourceLocator

public JavaUISourceLocator()
Constructs an empty source locator.

JavaUISourceLocator

public JavaUISourceLocator(IJavaProject[] projects,
                           boolean includeRequired)
                    throws JavaModelException
Constructs a new source locator that looks in the specified project for source, and required projects, if includeRequired is true.
Parameters:
projects - the projects in which to look for source
includeRequired - whether to look in required projects as well

JavaUISourceLocator

public JavaUISourceLocator(IJavaProject project)
                    throws CoreException
Constructs a source locator that searches for source in the given Java project, and all of its required projects, as specified by its build path or default source lookup settings.
Parameters:
project - Java project
Throws:
CoreException - if unable to read the project's build path
Method Detail

getSourceElement

public Object getSourceElement(IStackFrame stackFrame)
Specified by:
getSourceElement in interface ISourceLocator
See Also:
ISourceLocator.getSourceElement(IStackFrame)

getMemento

public String getMemento()
                  throws CoreException
Specified by:
getMemento in interface IPersistableSourceLocator
See Also:
IPersistableSourceLocator.getMemento()

initializeDefaults

public void initializeDefaults(ILaunchConfiguration configuration)
                        throws CoreException
Specified by:
initializeDefaults in interface IPersistableSourceLocator
See Also:
IPersistableSourceLocator.initializeDefaults(ILaunchConfiguration)

initializeFromMemento

public void initializeFromMemento(String memento)
                           throws CoreException
Specified by:
initializeFromMemento in interface IPersistableSourceLocator
See Also:
IPersistableSourceLocator.initializeFromMemento(String)

getSourceLocations

public IJavaSourceLocation[] getSourceLocations()
See Also:
JavaSourceLocator.getSourceLocations()

setSourceLocations

public void setSourceLocations(IJavaSourceLocation[] locations)
See Also:
JavaSourceLocator.setSourceLocations(IJavaSourceLocation[])

isFindAllSourceElements

public boolean isFindAllSourceElements()
Returns whether this source locator is configured to search for all source elements that correspond to a stack frame. When false is returned, searching stops on the first match. If there is more than one source element that corresponds to a stack frame, the user is prompted to choose a source element to open.
Returns:
whether this source locator is configured to search for all source elements that correspond to a stack frame
Since:
2.1

setFindAllSourceElement

public void setFindAllSourceElement(boolean findAll)
Sets whether this source locator is configured to search for all source elements that correspond to a stack frame, or the first match.
Parameters:
findAll - whether this source locator should search for all source elements that correspond to a stack frame
Since:
2.1

Eclipse JDT
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.