org.eclipse.cdt.debug.core.model
Interface ICBreakpoint

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.debug.core.model.IBreakpoint
All Known Subinterfaces:
ICAddressBreakpoint, ICFunctionBreakpoint, ICLineBreakpoint, ICWatchpoint
All Known Implementing Classes:
AbstractLineBreakpoint, CAddressBreakpoint, CBreakpoint, CFunctionBreakpoint, CLineBreakpoint, CWatchpoint

public interface ICBreakpoint
extends org.eclipse.debug.core.model.IBreakpoint

A breakpoint specific to the C/C++ debug model. A C/C++ breakpoint supports:


Field Summary
static java.lang.String CONDITION
          Breakpoint attribute storing the conditional expression associated with this breakpoint (value "org.eclipse.cdt.debug.core.condition").
static java.lang.String IGNORE_COUNT
          Breakpoint attribute storing a breakpoint's ignore count value (value "org.eclipse.cdt.debug.core.ignoreCount").
static java.lang.String INSTALL_COUNT
          Breakpoint attribute storing the number of debug targets a breakpoint is installed in (value "org.eclipse.cdt.debug.core.installCount").
static java.lang.String MODULE
          Breakpoint attribute storing the module name this breakpoint is set in (value "org.eclipse.cdt.debug.core.module").
static java.lang.String SOURCE_HANDLE
          Breakpoint attribute storing the source handle of the file this breakpoint is set in (value "org.eclipse.cdt.debug.core.sourceHandle").
static java.lang.String THREAD_ID
          Breakpoint attribute storing an identifier of the thread this breakpoint is restricted in (value "org.eclipse.cdt.debug.core.threadId").
 
Fields inherited from interface org.eclipse.debug.core.model.IBreakpoint
BREAKPOINT_MARKER, ENABLED, ID, LINE_BREAKPOINT_MARKER, PERSISTED, REGISTERED
 
Method Summary
 int decrementInstallCount()
          Decrements the install count of this breakpoint.
 java.lang.String getCondition()
          Returns the conditional expression associated with this breakpoint.
 int getIgnoreCount()
          Returns the ignore count used by this breakpoint.
 java.lang.String getModule()
          Returns the module name this breakpoint is set in.
 java.lang.String getSourceHandle()
          Returns the source handle this breakpoint is set in.
 ICDebugTarget[] getTargetFilters()
          Returns all target filters set on this breakpoint.
 ICThread[] getThreadFilters(ICDebugTarget target)
          Returns the threads in the given target in which this breakpoint is enabled or null if this breakpoint is enabled in all threads in the given target.
 java.lang.String getThreadId()
          Returns the identifier of the thread this breakpoint is restricted in.
 int incrementInstallCount()
          Increments the install count of this breakpoint
 boolean isConditional()
          Returns whether this breakpoint is conditional.
 boolean isInstalled()
          Returns whether this breakpoint is installed in at least one debug target.
 void removeTargetFilter(ICDebugTarget target)
          Removes the given target from the breakpoint's target list.
 void removeThreadFilters(ICThread[] threads)
          Removes this breakpoint's thread filters in the given target, if any.
 void resetInstallCount()
          Resets the install count of this breakpoint
 void setCondition(java.lang.String condition)
          Sets the condition associated with this breakpoint.
 void setIgnoreCount(int ignoreCount)
          Sets the ignore count attribute for this breakpoint.
 void setModule(java.lang.String module)
          Sets the module name of this breakpoint.
 void setSourceHandle(java.lang.String sourceHandle)
          Sets the source handle of this breakpoint.
 void setTargetFilter(ICDebugTarget target)
          Add the given target to the list of this breakpoint's targets.
 void setThreadFilters(ICThread[] threads)
          Restricts this breakpoint to suspend only in the given threads when encounterd in the given threads' target.
 void setThreadId(java.lang.String threadId)
          Restricts this breakpoint to suspend only in the given thread when encounterd in the given thread's target.
 
Methods inherited from interface org.eclipse.debug.core.model.IBreakpoint
delete, getMarker, getModelIdentifier, isEnabled, isPersisted, isRegistered, setEnabled, setMarker, setPersisted, setRegistered
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

INSTALL_COUNT

static final java.lang.String INSTALL_COUNT
Breakpoint attribute storing the number of debug targets a breakpoint is installed in (value "org.eclipse.cdt.debug.core.installCount"). This attribute is an int.

See Also:
Constant Field Values

CONDITION

static final java.lang.String CONDITION
Breakpoint attribute storing the conditional expression associated with this breakpoint (value "org.eclipse.cdt.debug.core.condition"). This attribute is a String.

See Also:
Constant Field Values

IGNORE_COUNT

static final java.lang.String IGNORE_COUNT
Breakpoint attribute storing a breakpoint's ignore count value (value "org.eclipse.cdt.debug.core.ignoreCount"). This attribute is an int.

See Also:
Constant Field Values

THREAD_ID

static final java.lang.String THREAD_ID
Breakpoint attribute storing an identifier of the thread this breakpoint is restricted in (value "org.eclipse.cdt.debug.core.threadId"). This attribute is a String.

See Also:
Constant Field Values

SOURCE_HANDLE

static final java.lang.String SOURCE_HANDLE
Breakpoint attribute storing the source handle of the file this breakpoint is set in (value "org.eclipse.cdt.debug.core.sourceHandle"). This attribute is a String.

See Also:
Constant Field Values

MODULE

static final java.lang.String MODULE
Breakpoint attribute storing the module name this breakpoint is set in (value "org.eclipse.cdt.debug.core.module"). This attribute is a String.

Since:
3.0
See Also:
Constant Field Values
Method Detail

isInstalled

boolean isInstalled()
                    throws org.eclipse.core.runtime.CoreException
Returns whether this breakpoint is installed in at least one debug target.

Returns:
whether this breakpoint is installed
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

isConditional

boolean isConditional()
                      throws org.eclipse.core.runtime.CoreException
Returns whether this breakpoint is conditional.

Returns:
whether this breakpoint is conditional
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

getCondition

java.lang.String getCondition()
                              throws org.eclipse.core.runtime.CoreException
Returns the conditional expression associated with this breakpoint.

Returns:
this breakpoint's conditional expression
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setCondition

void setCondition(java.lang.String condition)
                  throws org.eclipse.core.runtime.CoreException
Sets the condition associated with this breakpoint.

Parameters:
condition - the conditional expression
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

getIgnoreCount

int getIgnoreCount()
                   throws org.eclipse.core.runtime.CoreException
Returns the ignore count used by this breakpoint.

Returns:
the ignore count used by this breakpoint
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setIgnoreCount

void setIgnoreCount(int ignoreCount)
                    throws org.eclipse.core.runtime.CoreException
Sets the ignore count attribute for this breakpoint.

Parameters:
ignoreCount - the new ignore count
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

getThreadId

java.lang.String getThreadId()
                             throws org.eclipse.core.runtime.CoreException
Returns the identifier of the thread this breakpoint is restricted in.

Returns:
the thread identifier
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setThreadId

void setThreadId(java.lang.String threadId)
                 throws org.eclipse.core.runtime.CoreException
Restricts this breakpoint to suspend only in the given thread when encounterd in the given thread's target.

Parameters:
threadId - the thread identifier
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

getModule

java.lang.String getModule()
                           throws org.eclipse.core.runtime.CoreException
Returns the module name this breakpoint is set in.

Returns:
the module name
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setModule

void setModule(java.lang.String module)
               throws org.eclipse.core.runtime.CoreException
Sets the module name of this breakpoint.

Parameters:
module - the module name
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

getSourceHandle

java.lang.String getSourceHandle()
                                 throws org.eclipse.core.runtime.CoreException
Returns the source handle this breakpoint is set in.

Returns:
the source handle
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setSourceHandle

void setSourceHandle(java.lang.String sourceHandle)
                     throws org.eclipse.core.runtime.CoreException
Sets the source handle of this breakpoint.

Parameters:
sourceHandle - the source handle
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

incrementInstallCount

int incrementInstallCount()
                          throws org.eclipse.core.runtime.CoreException
Increments the install count of this breakpoint

Returns:
the new install count value
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

decrementInstallCount

int decrementInstallCount()
                          throws org.eclipse.core.runtime.CoreException
Decrements the install count of this breakpoint.

Returns:
the new install caount value
Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

resetInstallCount

void resetInstallCount()
                       throws org.eclipse.core.runtime.CoreException
Resets the install count of this breakpoint

Throws:
org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker

setTargetFilter

void setTargetFilter(ICDebugTarget target)
                     throws org.eclipse.core.runtime.CoreException
Add the given target to the list of this breakpoint's targets. Target filters are not persisted across workbench invocations.

Parameters:
target - the target to add to the list of this breakpoint's targets.
Throws:
org.eclipse.core.runtime.CoreException - if unable to set the target filter

removeTargetFilter

void removeTargetFilter(ICDebugTarget target)
                        throws org.eclipse.core.runtime.CoreException
Removes the given target from the breakpoint's target list. The breakpoint has no effect in the given target.

Parameters:
target - the target filter to be removed
Throws:
org.eclipse.core.runtime.CoreException - if unable to remove the target filter

setThreadFilters

void setThreadFilters(ICThread[] threads)
                      throws org.eclipse.core.runtime.CoreException
Restricts this breakpoint to suspend only in the given threads when encounterd in the given threads' target. All threads must be from the same target. Thread filters are not persisted across workbench invocations.

Parameters:
threads - the thread filters to be set
Throws:
org.eclipse.core.runtime.CoreException - if unable to set the thread filters

getTargetFilters

ICDebugTarget[] getTargetFilters()
                                 throws org.eclipse.core.runtime.CoreException
Returns all target filters set on this breakpoint.

Returns:
the targets that this breakpoint is resticted to
Throws:
org.eclipse.core.runtime.CoreException - if unable to determine this breakpoint's target filters

removeThreadFilters

void removeThreadFilters(ICThread[] threads)
                         throws org.eclipse.core.runtime.CoreException
Removes this breakpoint's thread filters in the given target, if any. Has no effect if this breakpoint does not have filters in the given target. All threads must be from the same target.

Parameters:
threads - the thread filters to be removed
Throws:
org.eclipse.core.runtime.CoreException - if unable to remove the thread filter

getThreadFilters

ICThread[] getThreadFilters(ICDebugTarget target)
                            throws org.eclipse.core.runtime.CoreException
Returns the threads in the given target in which this breakpoint is enabled or null if this breakpoint is enabled in all threads in the given target.

Returns:
the threads in the given target that this breakpoint is enabled for
Throws:
org.eclipse.core.runtime.CoreException - if unable to determine this breakpoint's thread filters