Package com.intellij.xdebugger.breakpoints

Class XBreakpointType<B extends XBreakpoint<P>,P extends XBreakpointProperties>

java.lang.Object

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

Direct Known Subclasses:

JavaBreakpointTypeBase, PyExceptionBreakpointType, XLineBreakpointType

public abstract class XBreakpointType<B extends XBreakpoint<P>,P extends XBreakpointProperties>
extends java.lang.Object

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

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

Use this class only for breakpoints like exception breakpoints in Java. If a breakpoint will be put on some line in a file use XLineBreakpointType instead

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBreakpointType.StandardPanels
static interface	XBreakpointType.XBreakpointCreator<P extends XBreakpointProperties>

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<XBreakpointType>	EXTENSION_POINT_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XBreakpointType(java.lang.String id, java.lang.String title)
protected	XBreakpointType(java.lang.String id, java.lang.String title, boolean suspendThreadSupported)

Method Summary

Modifier and Type	Method and Description
B	addBreakpoint(Project project, javax.swing.JComponent parentComponent) This method is called then "Add" button is pressed in the "Breakpoints" dialog
XBreakpointCustomPropertiesPanel<B>	createCustomConditionsPanel()
XBreakpointCustomPropertiesPanel<B>	createCustomPropertiesPanel() Deprecated. override createCustomPropertiesPanel(Project) instead
XBreakpointCustomPropertiesPanel<B>	createCustomPropertiesPanel(Project project)
XBreakpointCustomPropertiesPanel<B>	createCustomRightPropertiesPanel(Project project)
XBreakpointCustomPropertiesPanel<B>	createCustomTopPropertiesPanel(Project project)
XBreakpoint<P>	createDefaultBreakpoint(XBreakpointType.XBreakpointCreator<P> creator) Returns properties of the default breakpoint.
P	createProperties()
java.util.List<? extends AnAction>	getAdditionalPopupMenuActions(B breakpoint, XDebugSession currentSession)
java.util.Comparator<B>	getBreakpointComparator()
java.lang.String	getBreakpointsDialogHelpTopic()
SuspendPolicy	getDefaultSuspendPolicy()
javax.swing.Icon	getDisabledIcon()
abstract java.lang.String	getDisplayText(B breakpoint)
XDebuggerEditorsProvider	getEditorsProvider() Deprecated. override #getEditorsProvider(B, Project) instead
XDebuggerEditorsProvider	getEditorsProvider(B breakpoint, Project project)
javax.swing.Icon	getEnabledIcon()
java.util.List<XBreakpointGroupingRule<B,?>>	getGroupingRules()
java.lang.String	getId()
javax.swing.Icon	getInactiveDependentIcon()
javax.swing.Icon	getMutedDisabledIcon()
javax.swing.Icon	getMutedEnabledIcon()
javax.swing.Icon	getPendingIcon()
java.lang.String	getShortText(B breakpoint)
XSourcePosition	getSourcePosition(XBreakpoint<P> breakpoint) Override this method to define source position for a breakpoint.
javax.swing.Icon	getSuspendNoneIcon()
java.lang.String	getTitle()
java.util.EnumSet<XBreakpointType.StandardPanels>	getVisibleStandardPanels()
boolean	isAddBreakpointButtonVisible() Return true from this method in order to allow adding breakpoints from the "Breakpoints" dialog.
boolean	isSuspendThreadSupported()
boolean	shouldShowInBreakpointsDialog(Project project)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT_NAME

public static final ExtensionPointName<XBreakpointType> EXTENSION_POINT_NAME

Constructor Detail

XBreakpointType

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

Parameters:

id - an unique id of breakpoint type

title - title of tab in the breakpoints dialog

XBreakpointType

protected XBreakpointType(java.lang.String id,
                          java.lang.String title,
                          boolean suspendThreadSupported)

Parameters:

id - an unique id of breakpoint type

title - title of tab in the breakpoints dialog

suspendThreadSupported - true if suspending only one thread is supported for this type of breakpoints

Method Detail

createProperties

public P createProperties()

isSuspendThreadSupported

public boolean isSuspendThreadSupported()

Returns:

true if suspending only one thread is supported

getDefaultSuspendPolicy

public SuspendPolicy getDefaultSuspendPolicy()

getVisibleStandardPanels

public java.util.EnumSet<XBreakpointType.StandardPanels> getVisibleStandardPanels()

getId

public final java.lang.String getId()

getTitle

public java.lang.String getTitle()

getEnabledIcon

public javax.swing.Icon getEnabledIcon()

getDisabledIcon

public javax.swing.Icon getDisabledIcon()

getSuspendNoneIcon

public javax.swing.Icon getSuspendNoneIcon()

getMutedEnabledIcon

public javax.swing.Icon getMutedEnabledIcon()

getMutedDisabledIcon

public javax.swing.Icon getMutedDisabledIcon()

getPendingIcon

public javax.swing.Icon getPendingIcon()

Returns:

the icon shown for a breakpoint which is scheduled but not yet set (validated, resolved) in the debugger engine

getInactiveDependentIcon

public javax.swing.Icon getInactiveDependentIcon()

Returns:

the icon which is shown for a dependent breakpoint until its master breakpoint is reached

getDisplayText

public abstract java.lang.String getDisplayText(B breakpoint)

createCustomConditionsPanel

public XBreakpointCustomPropertiesPanel<B> createCustomConditionsPanel()

createCustomPropertiesPanel

public XBreakpointCustomPropertiesPanel<B> createCustomPropertiesPanel(Project project)

createCustomPropertiesPanel

@Deprecated
public XBreakpointCustomPropertiesPanel<B> createCustomPropertiesPanel()

Deprecated. override createCustomPropertiesPanel(Project) instead

createCustomRightPropertiesPanel

public XBreakpointCustomPropertiesPanel<B> createCustomRightPropertiesPanel(Project project)

createCustomTopPropertiesPanel

public XBreakpointCustomPropertiesPanel<B> createCustomTopPropertiesPanel(Project project)

getEditorsProvider

@Deprecated
public XDebuggerEditorsProvider getEditorsProvider()

Deprecated. override #getEditorsProvider(B, Project) instead

getEditorsProvider

public XDebuggerEditorsProvider getEditorsProvider(B breakpoint,
                                                   Project project)

getGroupingRules

public java.util.List<XBreakpointGroupingRule<B,?>> getGroupingRules()

getBreakpointComparator

public java.util.Comparator<B> getBreakpointComparator()

isAddBreakpointButtonVisible

public boolean isAddBreakpointButtonVisible()

Return true from this method in order to allow adding breakpoints from the "Breakpoints" dialog. Also override addBreakpoint(Project,JComponent) method.

Returns:

true if "Add" button should be visible in "Breakpoints" dialog

addBreakpoint

public B addBreakpoint(Project project,
                       javax.swing.JComponent parentComponent)

This method is called then "Add" button is pressed in the "Breakpoints" dialog

Parameters:

project -

parentComponent -

Returns:

the created breakpoint or null if breakpoint wasn't created

createDefaultBreakpoint

public XBreakpoint<P> createDefaultBreakpoint(XBreakpointType.XBreakpointCreator<P> creator)

Returns properties of the default breakpoint. The default breakpoints cannot be deleted and is always shown on top of the breakpoints list in the dialog.

Returns:

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

shouldShowInBreakpointsDialog

public boolean shouldShowInBreakpointsDialog(Project project)

getBreakpointsDialogHelpTopic

public java.lang.String getBreakpointsDialogHelpTopic()

getSourcePosition

public XSourcePosition getSourcePosition(XBreakpoint<P> breakpoint)

Override this method to define source position for a breakpoint. It will be used e.g. by 'Go To' and 'View Source' buttons in 'Breakpoints' dialog

getShortText

public java.lang.String getShortText(B breakpoint)

getAdditionalPopupMenuActions

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object