org.eclipse.ptp.debug.core.pdi.model
Interface IPDIBreakpoint

All Superinterfaces:

IPDISessionObject, IPDISet

All Known Subinterfaces:

IPDIAddressBreakpoint, IPDIExceptionpoint, IPDIFunctionBreakpoint, IPDILineBreakpoint, IPDILocationBreakpoint, IPDIWatchpoint

public interface IPDIBreakpoint
extends IPDISessionObject

Provides a basic functionality for the location breakpoints, watchpoints and catchpoints.

Field Summary

static int	HARDWARE Hardware type
static int	REGULAR Regular type
static int	TEMPORARY Temporary type

Method Summary

int	getBreakpointID() Returns breakpoint id of this breakpoint
IPDICondition	getCondition() Returns the condition of this breakpoint or null if no condition in this breakpoint
int	getInternalID() Returns internal breakpoint id
TaskSet	getPendingTasks() This is the set of pending tasks for the current operation.
boolean	isDeleted() Breakpoint has been marked for deletion.
boolean	isEnabled() Determines whether this breakpoint is enabled
boolean	isHardware() Determines whether this breakpoint is hardware-assisted
boolean	isTemporary() Determines whether this breakpoint is temporary
void	setBreakpointID(int bpid) Sets a breakpoint id for this breakpoint
void	setCondition(IPDICondition condition) Sets the condition of this breakpoint.
void	setDeleted() Marks the breakpoint for deletion.
void	setEnabled(boolean enabled) Sets the breakpoint state to be enabled or disabled.

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISessionObject

getSession

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISet

getTasks

Field Detail

REGULAR

static final int REGULAR

Regular type

See Also:

Constant Field Values

TEMPORARY

static final int TEMPORARY

Temporary type

See Also:

Constant Field Values

HARDWARE

static final int HARDWARE

Hardware type

See Also:

Constant Field Values

Method Detail

getBreakpointID

int getBreakpointID()

Returns breakpoint id of this breakpoint

Returns:

breakpoint id of this breakpoint

getCondition

IPDICondition getCondition()
                           throws PDIException

Returns the condition of this breakpoint or null if no condition in this breakpoint

Returns:

the condition of this breakpoint

Throws:

PDIException - on failure

getInternalID

int getInternalID()

Returns internal breakpoint id

Returns:

internal breakpoint id

getPendingTasks

TaskSet getPendingTasks()

This is the set of pending tasks for the current operation. If the breakpoint is marked for deletion, it's the tasks that still require the breakpoint to be removed. Otherwise, its the tasks on which the breakpoint still needs to be set.

Returns:

pending tasks

Since:

4.0

isDeleted

boolean isDeleted()

Breakpoint has been marked for deletion. The breakpoint is not actually removed until getPendingTasks().isEmpty() is true.

Returns:

true if breakpoint is being deleted

isEnabled

boolean isEnabled()
                  throws PDIException

Determines whether this breakpoint is enabled

Returns:

whether this breakpoint is enabled

Throws:

PDIException - on failure

isHardware

boolean isHardware()

Determines whether this breakpoint is hardware-assisted

Returns:

whether this breakpoint is hardware-assisted

isTemporary

boolean isTemporary()

Determines whether this breakpoint is temporary

Returns:

whether this breakpoint is temporary

setBreakpointID

void setBreakpointID(int bpid)

Sets a breakpoint id for this breakpoint

Parameters:

bpid - breakpoint id

setDeleted

void setDeleted()

Marks the breakpoint for deletion. The breakpoint should be considered deleted at this point and no further operations permitted.

setEnabled

void setEnabled(boolean enabled)
                throws PDIException

Sets the breakpoint state to be enabled or disabled.

Parameters:

enabled - whether this breakpoint should be enabled

Throws:

PDIException - on failure

setCondition

void setCondition(IPDICondition condition)
                  throws PDIException

Sets the condition of this breakpoint.

Parameters:

condition - the condition to set

Throws:

PDIException - on failure