Package com.intellij.xdebugger.breakpoints

Class XLineBreakpointType<P extends XBreakpointProperties>

java.lang.Object

com.intellij.xdebugger.breakpoints.XBreakpointType<XLineBreakpoint<P>,P>

com.intellij.xdebugger.breakpoints.XLineBreakpointType<P>

Direct Known Subclasses:

JavaLineBreakpointTypeBase, XLineBreakpointTypeBase, XsltBreakpointType

public abstract class XLineBreakpointType<P extends XBreakpointProperties>
extends XBreakpointType<XLineBreakpoint<P>,P>

Implement this class to support new type of line breakpoints. An implementation should be registered in a plugin.xml:

<extensions defaultExtensionNs="com.intellij">
<xdebugger.breakpointType implementation="qualified-class-name"/>
</extensions>

In order to support actual setting breakpoints in a debugging process create a XBreakpointHandler implementation and return it from XDebugProcess.getBreakpointHandlers() method

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XLineBreakpointType.XLineBreakpointAllVariant
class	XLineBreakpointType.XLineBreakpointVariant
class	XLineBreakpointType.XLinePsiElementBreakpointVariant

Nested classes/interfaces inherited from class com.intellij.xdebugger.breakpoints.XBreakpointType

XBreakpointType.StandardPanels, XBreakpointType.XBreakpointCreator<P extends XBreakpointProperties>

Field Summary

Fields inherited from class com.intellij.xdebugger.breakpoints.XBreakpointType

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XLineBreakpointType(java.lang.String id, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
boolean	canBeHitInOtherPlaces() Return true if this breakpoint could be hit on lines other than the one specified, an example is method breakpoint in java - it could be hit on any method overriding the one specified
boolean	canPutAt(VirtualFile file, int line, Project project) Return true if breakpoint can be put on line in file
java.util.List<? extends XLineBreakpointType.XLineBreakpointVariant>	computeVariants(Project project, XSourcePosition position) Return a list of variants if there can be more than one breakpoint on the line
Promise<java.util.List<? extends XLineBreakpointType.XLineBreakpointVariant>>	computeVariantsAsync(Project project, XSourcePosition position)
abstract P	createBreakpointProperties(VirtualFile file, int line) return non-null value if a breakpoint should have specific properties besides containing file and line.
XLineBreakpoint<P>	createDefaultBreakpoint(XBreakpointType.XBreakpointCreator<P> creator) Default line breakpoints aren't supported
java.util.List<? extends AnAction>	getAdditionalPopupMenuActions(XLineBreakpoint<P> breakpoint, XDebugSession currentSession)
java.lang.String	getDisplayText(XLineBreakpoint<P> breakpoint)
TextRange	getHighlightRange(XLineBreakpoint<P> breakpoint)
int	getPriority() Priority is considered when several breakpoint types can be set inside a folded code block, in this case we choose type with the highest priority Also it affects types sorting in various places
java.lang.String	getShortText(XLineBreakpoint<P> breakpoint)
XSourcePosition	getSourcePosition(XBreakpoint<P> breakpoint) Source position for line breakpoint by default is determined by its file and line
javax.swing.Icon	getTemporaryIcon()

Methods inherited from class com.intellij.xdebugger.breakpoints.XBreakpointType

addBreakpoint, createCustomConditionsPanel, createCustomPropertiesPanel, createCustomPropertiesPanel, createCustomRightPropertiesPanel, createCustomTopPropertiesPanel, createProperties, getBreakpointComparator, getBreakpointsDialogHelpTopic, getDefaultSuspendPolicy, getDisabledIcon, getEditorsProvider, getEditorsProvider, getEnabledIcon, getGroupingRules, getId, getInactiveDependentIcon, getMutedDisabledIcon, getMutedEnabledIcon, getPendingIcon, getSuspendNoneIcon, getTitle, getVisibleStandardPanels, isAddBreakpointButtonVisible, isSuspendThreadSupported, shouldShowInBreakpointsDialog, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XLineBreakpointType

protected XLineBreakpointType(java.lang.String id,
                              java.lang.String title)

Method Detail

canPutAt

public boolean canPutAt(VirtualFile file,
                        int line,
                        Project project)

Return true if breakpoint can be put on line in file

createBreakpointProperties

public abstract P createBreakpointProperties(VirtualFile file,
                                             int line)

return non-null value if a breakpoint should have specific properties besides containing file and line. These properties will be stored in XBreakpoint instance and can be obtained by using XBreakpoint.getProperties() method

getDisplayText

public java.lang.String getDisplayText(XLineBreakpoint<P> breakpoint)

Specified by:

getDisplayText in class XBreakpointType<XLineBreakpoint<P extends XBreakpointProperties>,P extends XBreakpointProperties>

getSourcePosition

public XSourcePosition getSourcePosition(XBreakpoint<P> breakpoint)

Source position for line breakpoint by default is determined by its file and line

Overrides:

getSourcePosition in class XBreakpointType<XLineBreakpoint<P extends XBreakpointProperties>,P extends XBreakpointProperties>

getShortText

public java.lang.String getShortText(XLineBreakpoint<P> breakpoint)

Overrides:

getShortText in class XBreakpointType<XLineBreakpoint<P extends XBreakpointProperties>,P extends XBreakpointProperties>

createDefaultBreakpoint

public final XLineBreakpoint<P> createDefaultBreakpoint(XBreakpointType.XBreakpointCreator<P> creator)

Default line breakpoints aren't supported

Overrides:

createDefaultBreakpoint in class XBreakpointType<XLineBreakpoint<P extends XBreakpointProperties>,P extends XBreakpointProperties>

Returns:

a default breakpoint or null if default breakpoint isn't supported

getAdditionalPopupMenuActions

public java.util.List<? extends AnAction> getAdditionalPopupMenuActions(XLineBreakpoint<P> breakpoint,
                                                                        XDebugSession currentSession)

Overrides:

getAdditionalPopupMenuActions in class XBreakpointType<XLineBreakpoint<P extends XBreakpointProperties>,P extends XBreakpointProperties>

getTemporaryIcon

public javax.swing.Icon getTemporaryIcon()

getPriority

public int getPriority()

Priority is considered when several breakpoint types can be set inside a folded code block, in this case we choose type with the highest priority Also it affects types sorting in various places

canBeHitInOtherPlaces

public boolean canBeHitInOtherPlaces()

Return true if this breakpoint could be hit on lines other than the one specified, an example is method breakpoint in java - it could be hit on any method overriding the one specified

getHighlightRange

public TextRange getHighlightRange(XLineBreakpoint<P> breakpoint)

Returns:

range to highlight on the line, null to highlight the whole line

computeVariants

public java.util.List<? extends XLineBreakpointType.XLineBreakpointVariant> computeVariants(Project project,
                                                                                            XSourcePosition position)

Return a list of variants if there can be more than one breakpoint on the line

computeVariantsAsync

public Promise<java.util.List<? extends XLineBreakpointType.XLineBreakpointVariant>> computeVariantsAsync(Project project,
                                                                                                          XSourcePosition position)