org.eclipse.jdt.launching.sourcelookup
Interface IJavaSourceLocation

All Superinterfaces:

IAdaptable

All Known Implementing Classes:

ArchiveSourceLocation, DirectorySourceLocation, JavaProjectSourceLocation

public interface IJavaSourceLocation

extends IAdaptable

A source location defines the location of a repository of source code. A source location is capable of retrieving source elements.

For example, a source location could be a project, zip/archive file, or a directory in the file system.

This interface is may be implemented.

Since:

2.0

Method Summary

Object	findSourceElement(String name) Returns an object representing the source code for a type with the specified name, or null if none could be found.
String	getMemento() Returns a memento for this source location from which this source location can be reconstructed.
void	initializeFrom(String memento) Initializes this source location from the given memento.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

findSourceElement

public Object findSourceElement(String name)
                         throws CoreException

Returns an object representing the source code for a type with the specified name, or null if none could be found. The name is a fully qualified type name, and may contain the '$' character when referring to inner types. For example, java.lang.String. The source element returned is implementation specific - for example, a resource, a local file, a zip file entry, etc.

Parameters:

name - fully qualified name of the type for which source is being searched for

Returns:

source element

Throws:

CoreException - if an exception occurs while searching for the specified source element

getMemento

public String getMemento()
                  throws CoreException

Returns a memento for this source location from which this source location can be reconstructed.

Returns:

a memento for this source location

Throws:

CoreException - if unable to create a memento

initializeFrom

public void initializeFrom(String memento)
                    throws CoreException

Initializes this source location from the given memento.

Parameters:

memento - a memento generated by this source location

Throws:

CoreException - if unable to initialize this source location