Eclipse Platform
Release 3.1

org.eclipse.debug.core.model
Interface IWatchpoint

All Superinterfaces:
IAdaptable, IBreakpoint

public interface IWatchpoint
extends IBreakpoint

A breakpoint that suspends when an associated variable is read or written.

Clients may implement this interface. Clients are not required to implement this interface to implement watchpoints, but those that do inherit default rendering of images for watchpoints from the debug platform's default label provider and actions to toggle access and modification properties of a watchpoint.

Since:
3.1

Field Summary
 
Fields inherited from interface org.eclipse.debug.core.model.IBreakpoint
BREAKPOINT_MARKER, ENABLED, ID, LINE_BREAKPOINT_MARKER, PERSISTED, REGISTERED
 
Method Summary
 boolean isAccess()
          Returns whether this watchpoint will suspend execution when its associated variable is accessed (read).
 boolean isModification()
          Returns whether this watchpoint will suspend execution when its associated variable is written.
 void setAccess(boolean access)
          Sets whether this breakpoint will suspend execution when its associated variable is accessed.
 void setModification(boolean modification)
          Sets whether this breakpoint will suspend execution when its associated variable is modified.
 boolean supportsAccess()
          Returns whether this breakpoints supports the capability to suspend when an associated variable is read.
 boolean supportsModification()
          Returns whether this breakpoints supports the ability to suspend when an associated variable is written.
 
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
 

Method Detail

isAccess

public boolean isAccess()
                 throws CoreException
Returns whether this watchpoint will suspend execution when its associated variable is accessed (read).

Returns:
whether this is an access watchpoint
Throws:
CoreException - if unable to access the property on this breakpoint's underlying marker

setAccess

public void setAccess(boolean access)
               throws CoreException
Sets whether this breakpoint will suspend execution when its associated variable is accessed.

Parameters:
access - whether to suspend on access
Throws:
CoreException - if unable to set the property on this breakpoint's underlying marker or if the capability is not supported

isModification

public boolean isModification()
                       throws CoreException
Returns whether this watchpoint will suspend execution when its associated variable is written.

Returns:
whether this is a modification watchpoint
Throws:
CoreException - if unable to access the property on this breakpoint's underlying marker

setModification

public void setModification(boolean modification)
                     throws CoreException
Sets whether this breakpoint will suspend execution when its associated variable is modified.

Parameters:
modification - whether to suspend on modification
Throws:
CoreException - if unable to set the property on this breakpoint's underlying marker or if the capability is not supported

supportsAccess

public boolean supportsAccess()
Returns whether this breakpoints supports the capability to suspend when an associated variable is read.

Returns:
whether this breakpoints supports the capability to suspend when an associated variable is read

supportsModification

public boolean supportsModification()
Returns whether this breakpoints supports the ability to suspend when an associated variable is written.

Returns:
whether this breakpoints supports the ability to suspend when an associated variable is written

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.