Package com.intellij.debugger

Interface PositionManager

All Known Subinterfaces:

MultiRequestPositionManager

All Known Implementing Classes:

CompoundPositionManager, GroovyPositionManager, JavaScratchPositionManager, JSR45PositionManager, PositionManagerEx, PositionManagerImpl, SpringLoadedPositionManager

public interface PositionManager

Manages the correspondence between source positions and bytecode locations during JVM debugging. Instances of this class are created by the factory registered via the PositionManagerFactory extension point.

See Also:

JSR45PositionManager

Method Summary

Modifier and Type	Method and Description
com.sun.jdi.request.ClassPrepareRequest	createPrepareRequest(ClassPrepareRequestor requestor, SourcePosition position) Called to request the JVM to notify the debugger engine when a class corresponding to a breakpoint location is loaded.
default java.util.Set<? extends FileType>	getAcceptedFileTypes() Return file types this position manager accepts
java.util.List<com.sun.jdi.ReferenceType>	getAllClasses(SourcePosition classPosition) Returns the list of all Java classes corresponding to the specified position in the source code.
SourcePosition	getSourcePosition(com.sun.jdi.Location location) Returns the source position corresponding to the specified bytecode location.
java.util.List<com.sun.jdi.Location>	locationsOfLine(com.sun.jdi.ReferenceType type, SourcePosition position) Returns the list of bytecode locations in a specific class corresponding to the specified position in the source code.

Method Detail

getSourcePosition

SourcePosition getSourcePosition(com.sun.jdi.Location location)
                          throws NoDataException

Returns the source position corresponding to the specified bytecode location.

Parameters:

location - the bytecode location.

Returns:

the corresponding source position.

Throws:

NoDataException - if the location is not in the code managed by this PositionManager

getAllClasses

java.util.List<com.sun.jdi.ReferenceType> getAllClasses(SourcePosition classPosition)
                                                 throws NoDataException

Returns the list of all Java classes corresponding to the specified position in the source code.

Parameters:

classPosition - the source position.

Returns:

the list of corresponding Java classes.

Throws:

NoDataException - if the location is not in the code managed by this PositionManager

See Also:

VirtualMachineProxy.classesByName(java.lang.String)

locationsOfLine

java.util.List<com.sun.jdi.Location> locationsOfLine(com.sun.jdi.ReferenceType type,
                                                     SourcePosition position)
                                              throws NoDataException

Returns the list of bytecode locations in a specific class corresponding to the specified position in the source code.

Parameters:

type - a Java class (one of the list returned by getAllClasses(com.intellij.debugger.SourcePosition)).

position - the position in the source code.

Returns:

the list of corresponding bytecode locations.

Throws:

NoDataException - if the location is not in the code managed by this PositionManager

See Also:

ReferenceType.locationsOfLine(int)

createPrepareRequest

com.sun.jdi.request.ClassPrepareRequest createPrepareRequest(ClassPrepareRequestor requestor,
                                                             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 RequestManager.createClassPrepareRequest(com.intellij.debugger.requests.ClassPrepareRequestor, java.lang.String) to create the request.

Parameters:

requestor - the object to receive the notification from the JVM.

position - the location of a breakpoint.

Returns:

the prepare request, or null if the code is managed by this PositionManager but no class prepare notification is needed

Throws:

NoDataException - if the position is not in the code managed by this PositionManager

getAcceptedFileTypes

default java.util.Set<? extends FileType> getAcceptedFileTypes()

Return file types this position manager accepts

Returns:

set of accepted file types, or null if it accepts all