oracle.jdeveloper.model
Interface PackagedSource

All Known Implementing Classes:

JavaSourceNode, JspSourceNode

public interface PackagedSource

The Interface to get the package and file name from a source file.

The debugger within JDeveloper uses this interface to support source breakpoints in a file. Source breakpoints are identified by package, file name, and line number.

When the user clicks in the margin of the code editor, the debugger looks to see if the Document implements this interface and if so, it calls getPackage and getSourceFile.

Also, the debugger and profiler, use this interface in order to find and show the source code locations.

If a Document does not implement this interface, the package will be determined based on the directory of the Document, relative to the project's source path. See Source.getPackageFromNode(oracle.ide.model.Node, oracle.ide.model.Project) and Source.getFilenameFromNode(oracle.ide.model.Node). JavaSourceNode and JspSourceNode both implement this interface.

Method Summary

java.lang.String	getPackage(Project project) Returns the package for the source file.
java.lang.String	getSourceFile() Returns the file name for the source file.

Method Detail

getPackage

java.lang.String getPackage(Project project)

Returns the package for the source file.

Parameters:

project - the project which contains the source file

Returns:

the package for the source file.

getSourceFile

java.lang.String getSourceFile()

Returns the file name for the source file.

In the case of a normal Java file, this method should return the source file attribute, defined as the following: Only the name of the source file is given by the source file attribute it never represents the name of a directory containing the file or an absolute path name for the file. For instance the source file attribute may contain file name foo.java but not the UNIX path name /home/jdevwork/workspace1/project1/package1/foo.java.

Returns:

the source file name for the source file.