|
Eclipse JDT Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IJavaBreakpoint
A breakpoint specific to the Java debug model. A Java breakpoint supports:
Field Summary | |
---|---|
static int |
SUSPEND_THREAD
Default suspend policy constant indicating a breakpoint will suspend only the thread in which it occurred. |
static int |
SUSPEND_VM
Suspend policy constant indicating a breakpoint will suspend the target VM when hit. |
Fields inherited from interface org.eclipse.debug.core.model.IBreakpoint |
---|
BREAKPOINT_MARKER, ENABLED, ID, LINE_BREAKPOINT_MARKER, PERSISTED, REGISTERED |
Method Summary | |
---|---|
void |
addBreakpointListener(String identifier)
Adds the breakpoint listener extension with specified identifier to this breakpoint. |
void |
addInstanceFilter(IJavaObject object)
Adds the given object to the list of objects in which this breakpoint is restricted to suspend execution. |
String[] |
getBreakpointListeners()
Returns a collection of identifiers of breakpoint listener extensions registered for this breakpoint, possibly empty. |
int |
getHitCount()
Returns this breakpoint's hit count or, -1 if this breakpoint does not have a hit count. |
IJavaObject[] |
getInstanceFilters()
Returns the current set of active instance filters. |
int |
getSuspendPolicy()
Returns the suspend policy used by this breakpoint, one of SUSPEND_VM or SUSPEND_THREAD . |
IJavaThread |
getThreadFilter(IJavaDebugTarget target)
Returns the thread in the given target in which this breakpoint is enabled or null if this breakpoint is enabled in
all threads in the given target. |
IJavaThread[] |
getThreadFilters()
Returns all thread filters set on this breakpoint. |
String |
getTypeName()
Returns the fully qualified name of the type this breakpoint is located in, or null if this breakpoint
is not located in a specific type - for example, a pattern breakpoint. |
boolean |
isInstalled()
Returns whether this breakpoint is installed in at least one debug target. |
boolean |
removeBreakpointListener(String identifier)
Removes the breakpoint listener extension with the specified identifier from this breakpoint and returns whether the listener was removed. |
void |
removeInstanceFilter(IJavaObject object)
Removes the given object from the list of objects in which this breakpoint is restricted to suspend execution. |
void |
removeThreadFilter(IJavaDebugTarget target)
Removes this breakpoint's thread filter in the given target, if any. |
void |
setHitCount(int count)
Sets the hit count attribute of this breakpoint. |
void |
setSuspendPolicy(int suspendPolicy)
Sets whether all threads in the target VM will be suspended when this breakpoint is hit. |
void |
setThreadFilter(IJavaThread thread)
Restricts this breakpoint to suspend only in the given thread when encountered in the given thread's target. |
boolean |
supportsInstanceFilters()
Returns whether this breakpoints supports instance filters. |
boolean |
supportsThreadFilters()
Returns whether this breakpoints supports thread filters. |
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 |
---|
static final int SUSPEND_VM
static final int SUSPEND_THREAD
Method Detail |
---|
boolean isInstalled() throws CoreException
CoreException
- if unable to access the property
on this breakpoint's underlying markerString getTypeName() throws CoreException
null
if this breakpoint
is not located in a specific type - for example, a pattern breakpoint.
null
CoreException
- if unable to access the property
from this breakpoint's underlying markerint getHitCount() throws CoreException
CoreException
- if unable to access the property
from this breakpoint's underlying markervoid setHitCount(int count) throws CoreException
count
- the new hit count
CoreException
- if unable to set the property
on this breakpoint's underlying markervoid setSuspendPolicy(int suspendPolicy) throws CoreException
SUSPEND_VM
the target
VM is suspended, and when SUSPEND_THREAD
only the thread
in which this breakpoint occurred is suspended.
suspendPolicy
- one of SUSPEND_VM
or
SUSPEND_THREAD
CoreException
- if unable to set the property
on this breakpoint's underlying markerint getSuspendPolicy() throws CoreException
SUSPEND_VM
or SUSPEND_THREAD
.
SUSPEND_VM
or SUSPEND_THREAD
CoreException
- if unable to access the property
from this breakpoint's underlying markervoid setThreadFilter(IJavaThread thread) throws CoreException
CoreException
- if unable to set the thread filtervoid removeThreadFilter(IJavaDebugTarget target) throws CoreException
target
- the target whose thread filter will be removed
CoreException
- if unable to remove the thread filterIJavaThread getThreadFilter(IJavaDebugTarget target) throws CoreException
null
if this breakpoint is enabled in
all threads in the given target.
CoreException
- if unable to determine this breakpoint's thread
filterIJavaThread[] getThreadFilters() throws CoreException
CoreException
- if unable to determine this breakpoint's
thread filtersvoid addInstanceFilter(IJavaObject object) throws CoreException
Note: This implementation will add more than one filter. However, if there is more than one instance filter for a debug target, the breakpoint will never be hit in that target, as the current context cannot be two different instances at the same time.
object
- instance filter to add
CoreException
- if unable to add the given instance filtervoid removeInstanceFilter(IJavaObject object) throws CoreException
object
- instance filter to remove
CoreException
- if unable to remove the given instance filterboolean supportsInstanceFilters()
IJavaObject[] getInstanceFilters() throws CoreException
CoreException
- if unable to retrieve the listboolean supportsThreadFilters()
String[] getBreakpointListeners() throws CoreException
CoreException
- if unable to retrieve the collectionvoid addBreakpointListener(String identifier) throws CoreException
identifier
- breakpoint listener extension identifier
CoreException
- if unable to add the listenerboolean removeBreakpointListener(String identifier) throws CoreException
identifier
- breakpoint listener extension identifier
CoreException
- if an error occurs removing the listener
|
Eclipse JDT Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2011 IBM Corporation and others. All rights reserved.