Eclipse JDT Plug-in Developer Guide (Galileo) - IJavaExceptionBreakpoint (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.debug.core
Interface IJavaExceptionBreakpoint

All Superinterfaces:: IAdaptable, IBreakpoint, IJavaBreakpoint

public interface IJavaExceptionBreakpoint
extends IJavaBreakpoint
extends IJavaBreakpoint

A breakpoint that suspends execution when a corresponding exception is thrown in a target VM. An exception breakpoint can be configured to suspend execution when the corresponding exception is thrown in a caught or uncaught location. As well, the location can be filtered inclusively or exclusively by type name patterns.

Since:: 2.0
Restriction:: This interface is not intended to be implemented by clients.
Restriction:: This interface is not intended to be extended by clients.

Field Summary

Fields inherited from interface org.eclipse.jdt.debug.core. IJavaBreakpoint

SUSPEND_THREAD, SUSPEND_VM

Fields inherited from interface org.eclipse.debug.core.model. IBreakpoint

BREAKPOINT_MARKER, ENABLED, ID, LINE_BREAKPOINT_MARKER, PERSISTED, REGISTERED

Method Summary

String getExceptionTypeName ()
          Returns the fully qualified type name of the exception that last caused this breakpoint to suspend, of null if this breakpoint has not caused a thread to suspend.

String[] getExclusionFilters ()
          Returns the exclusive filters that define the scope for the associated exception.

String[] getFilters ()
          Deprecated. Use getExclusionFilters() or getInclusionFilters()

String[] getInclusionFilters ()
          Returns the inclusive filters that define the scope for the associated exception.

boolean isCaught ()
          Returns whether this breakpoint suspends execution when the associated exception is thrown in a caught location (in a try/catch statement).

boolean isChecked ()
          Returns whether the exception associated with this breakpoint is a checked exception (compiler detected).

boolean isInclusiveFiltered ()
          Deprecated. Exception breakpoints can have a mixed set of filters and this method is maintained strictly for API backwards compatibility

boolean isUncaught ()
          Returns whether this breakpoint suspends execution when the associated exception is thrown in an uncaught location (not caught by a try/catch statement).

void setCaught (boolean caught)
          Sets whether this breakpoint suspends execution when the associated exception is thrown in a caught location (in a try/catch statement).

void setExclusionFilters ( String[] filters)
          Sets the exclusion filters that will define the scope for the associated exception.

void setFilters ( String[] filters, boolean inclusive)
          Deprecated. Exception breakpoints can have a mixed set of filters. Use setInclusiveFilters(String[] filters) or setExclusiveFilters(String[] filters)

void setInclusionFilters ( String[] filters)
          Sets the inclusion filters that will define the scope for the associated exception.

void setUncaught (boolean uncaught)
          Sets whether this breakpoint suspends execution when the associated exception is thrown in an uncaught location.

Methods inherited from interface org.eclipse.jdt.debug.core. IJavaBreakpoint

addBreakpointListener, addInstanceFilter, getBreakpointListeners, getHitCount, getInstanceFilters, getSuspendPolicy, getThreadFilter, getThreadFilters, getTypeName, isInstalled, removeBreakpointListener, removeInstanceFilter, removeThreadFilter, setHitCount, setSuspendPolicy, setThreadFilter, supportsInstanceFilters, supportsThreadFilters

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

setInclusionFilters

void setInclusionFilters(
String[] filters)
                         throws 
CoreException

Sets the inclusion filters that will define the scope for the associated exception. Filters are a collection of strings of type name prefixes. Default packages should be specified as the empty string.

Parameters:: filters - the array of filters to apply
Throws:: CoreException - if unable to set the property on this breakpoint's underlying marker
Since:: 2.1

getInclusionFilters


String[] getInclusionFilters()
                             throws 
CoreException

Returns the inclusive filters that define the scope for the associated exception. Filters are a collection of strings of type name prefixes.

Returns:: the array of defined inclusive filters
Throws:: CoreException - if unable to access the property on this breakpoint's underlying marker
Since:: 2.1

isCaught

boolean isCaught()
                 throws 
CoreException

Returns whether this breakpoint suspends execution when the associated exception is thrown in a caught location (in a try/catch statement).

Returns:: true if this is a caught exception breakpoint
Throws:: CoreException - if unable to access the property from this breakpoint's underlying marker

isUncaught

boolean isUncaught()
                   throws 
CoreException

Returns whether this breakpoint suspends execution when the associated exception is thrown in an uncaught location (not caught by a try/catch statement).

Returns:: true if this is an uncaught exception breakpoint.
Throws:: CoreException - if unable to access the property from this breakpoint's underlying marker

setCaught

void setCaught(boolean caught)
               throws 
CoreException

Sets whether this breakpoint suspends execution when the associated exception is thrown in a caught location (in a try/catch statement).

Parameters:: caught - whether or not this breakpoint suspends execution when the associated exception is thrown in a caught location
Throws:: CoreException - if unable to set the property on this breakpoint's underlying marker

setUncaught

void setUncaught(boolean uncaught)
                 throws 
CoreException

Sets whether this breakpoint suspends execution when the associated exception is thrown in an uncaught location.

Parameters:: uncaught - whether or not this breakpoint suspends execution when the associated exception is thrown in an uncaught location
Throws:: CoreException - if unable to set the property on this breakpoint's underlying marker

isChecked

boolean isChecked()
                  throws 
CoreException

Returns whether the exception associated with this breakpoint is a checked exception (compiler detected).

Returns:: true if the exception associated with this breakpoint is a checked exception
Throws:: CoreException - if unable to access the property from this breakpoint's underlying marker

getExceptionTypeName


String getExceptionTypeName()

Returns the fully qualified type name of the exception that last caused this breakpoint to suspend, of null if this breakpoint has not caused a thread to suspend. Note that this name may be a sub type of the exception that this breakpoint is associated with.

Returns:: fully qualified exception name or null

setFilters

void setFilters(
String[] filters,
                boolean inclusive)
                throws 
CoreException

Deprecated. Exception breakpoints can have a mixed set of filters. Use setInclusiveFilters(String[] filters) or setExclusiveFilters(String[] filters)

Sets the filters that will define the scope for the associated exception. Filters are a collection of strings of type name prefixes. Default packages should be specified as the empty string.

Parameters:: filters - the array of filters to apply; inclusive - whether or not to apply the filters as inclusive or exclusive
Throws:: CoreException - if unable to set the property on this breakpoint's underlying marker

setExclusionFilters

void setExclusionFilters(
String[] filters)
                         throws 
CoreException

Sets the exclusion filters that will define the scope for the associated exception. Filters are a collection of strings of type name prefixes. Default packages should be specified as the empty string.

Parameters:: filters - the array of filters to apply
Throws:: CoreException - if unable to set the property on this breakpoint's underlying marker
Since:: 2.1

getFilters


String[] getFilters()
                    throws 
CoreException

Deprecated. Use getExclusionFilters() or getInclusionFilters()

Returns the filters that define the scope for the associated exception. Filters are a collection of strings of type name prefixes.

Returns:: the array of defined filters
Throws:: CoreException - if unable to access the property on this breakpoint's underlying marker

getExclusionFilters


String[] getExclusionFilters()
                             throws 
CoreException

Returns the exclusive filters that define the scope for the associated exception. Filters are a collection of strings of type name prefixes.

Returns:: the array of defined inclusive filters
Throws:: CoreException - if unable to access the property on this breakpoint's underlying marker
Since:: 2.1

isInclusiveFiltered

boolean isInclusiveFiltered()
                            throws 
CoreException

Deprecated. Exception breakpoints can have a mixed set of filters and this method is maintained strictly for API backwards compatibility

Returns whether any inclusive filters have been applied.

Returns:: true if the inclusive filters have been applied
Throws:: CoreException - if unable to access the property on this breakpoint's underlying marker