From 9cc92843632e706b6016473d4d5744e503257514 Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Wed, 13 Jul 2011 16:02:18 +0200 Subject: [PATCH 1/3] javadoc --- .../intellij/debugger/PositionManager.java | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java b/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java index 86c3d1cbde5c..100ff7793a2d 100644 --- a/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java +++ b/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java @@ -24,16 +24,54 @@ import org.jetbrains.annotations.Nullable; import java.util.List; +/** + * Manages the correspondence between source positions and bytecode locations during JVM debugging. + * Instances of this class are created by the factory registered via the {@link PositionManagerFactory} extension point. + * + * @see com.intellij.debugger.engine.JSR45PositionManager + */ public interface PositionManager { + /** + * Returns the source position corresponding to the specified bytecode location. + * + * @param location the bytecode location. + * @return the corresponding source position. + * @throws NoDataException if the location is not in the code managed by this {@code PositionManager} + */ @Nullable SourcePosition getSourcePosition(@Nullable Location location) throws NoDataException; + /** + * Returns the list of all Java classes corresponding to the specified position in the source code. + * + * @param classPosition the source position. + * @return the list of corresponding Java classes. + * @throws NoDataException if the location is not in the code managed by this {@code PositionManager} + */ @NotNull List getAllClasses(SourcePosition classPosition) throws NoDataException; + /** + * Returns the list of bytecode locations in a specific class corresponding to the specified position in the source code. + * + * @param type a Java class (one of the list returned by {@link #getAllClasses}). + * @param position the position in the source code. + * @return the list of corresponding bytecode locations. + * @throws NoDataException if the location is not in the code managed by this {@code PositionManager} + */ @NotNull List locationsOfLine(ReferenceType type, SourcePosition position) throws NoDataException; + /** + * Called to request the JVM to notify the debugger engine when a class corresponding to a breakpoint location is loaded. + * The implementation should calculate the pattern of the class files corresponding to the breakpoint location and call + * {@link com.intellij.debugger.requests.RequestManager#createClassPrepareRequest} to create the request. + * + * @param requestor the object to receive the notification from the JVM. + * @param position the location of a breakpoint. + * @return the prepare request, or null if the code is managed by this {@code PositionManager} but no class prepare notification is needed + * @throws NoDataException if the position is not in the code managed by this {@code PositionManager} + */ @Nullable ClassPrepareRequest createPrepareRequest(ClassPrepareRequestor requestor, SourcePosition position) throws NoDataException; } From a24b1d977d18232d4ce0a66bcf343af76f118863 Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Thu, 14 Jul 2011 12:08:42 +0200 Subject: [PATCH 2/3] a tiny bit of javadoc --- .../openapi/src/com/intellij/debugger/PositionManager.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java b/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java index 100ff7793a2d..5713483f6357 100644 --- a/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java +++ b/java/debugger/openapi/src/com/intellij/debugger/PositionManager.java @@ -47,6 +47,7 @@ public interface PositionManager { * @param classPosition the source position. * @return the list of corresponding Java classes. * @throws NoDataException if the location is not in the code managed by this {@code PositionManager} + * @see com.intellij.debugger.engine.jdi.VirtualMachineProxy#classesByName */ @NotNull List getAllClasses(SourcePosition classPosition) throws NoDataException; @@ -58,6 +59,7 @@ public interface PositionManager { * @param position the position in the source code. * @return the list of corresponding bytecode locations. * @throws NoDataException if the location is not in the code managed by this {@code PositionManager} + * @see ReferenceType#locationsOfLine(int) */ @NotNull List locationsOfLine(ReferenceType type, SourcePosition position) throws NoDataException; From 576a1c48f02eacecb8d03107f9a5d4a8fb748b78 Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Sat, 16 Jul 2011 11:49:07 +0200 Subject: [PATCH 3/3] fix libraryName definition for swingx --- build/scripts/libLicenses.gant | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/scripts/libLicenses.gant b/build/scripts/libLicenses.gant index 1de13ee98551..9dbaef3afb65 100644 --- a/build/scripts/libLicenses.gant +++ b/build/scripts/libLicenses.gant @@ -185,7 +185,7 @@ libraryLicense(name: "Saxon-6.5.5", version: "6.5.5", license: "Mozilla Public L libraryLicense(name: "Sonatype Nexus: Indexer", libraryName: "nexus-indexer-1.2.3.jar", version: "1.2.3", license: "Eclipse Public License", url: "http://nexus.sonatype.org/", licenseUrl: "http://www.eclipse.org/org/documents/epl-v10.html") libraryLicense(name: "Sonatype Nexus: Indexer", libraryName: "nexus-indexer-3.0.4.jar", version: "3.0.4", license: "Eclipse Public License", url: "http://nexus.sonatype.org/", licenseUrl: "http://www.eclipse.org/org/documents/epl-v10.html") libraryLicense(name: "SVNKit", libraryName: "svnkit.jar", version: "SVN version, 1.1 branch as of 1 Oct 2007", license: "link (commercial license)", url: "http://www.svnkit.com/", licenseUrl: "http://svnkit.com/license.html") -libraryLicense(name: "swingx", libraryName: "swingx-core-1.6.2.jar", version: "1.6.2", license: "LGPL 2.1", url: "http://java.net/downloads/swingx/", licenseUrl: "http://www.opensource.org/licenses/lgpl-2.1.php") +libraryLicense(name: "swingx", libraryName: "swingx", version: "1.6.2", license: "LGPL 2.1", url: "http://java.net/downloads/swingx/", licenseUrl: "http://www.opensource.org/licenses/lgpl-2.1.php") libraryLicense(name: "TestNG", version: "5.7 snapshot", license: "Apache 2.0", url: "http://testng.org/doc/", licenseUrl: "http://code.google.com/p/testng/") libraryLicense(name: "Trilead SSH", libraryName: "trilead-ssh2", version: "build 213", license: "BSD style (see LICENSE.txt in trilead.jar)", url: "http://www.trilead.com/SSH_Library/") libraryLicense(name: "Trove4j", version: "1.1 (with patches by JetBrains)", license: "LGPL", url: "http://trove4j.sourceforge.net/", licenseUrl: "http://trove4j.sourceforge.net/html/license.html")