Top Description Fields Methods
com.sun.jdi.request

public Interface ExceptionRequest

extends EventRequest
Known Direct Implementers
com.sun.tools.jdi.EventRequestManagerImpl.ExceptionRequestImpl
Imports
com.sun.jdi.ObjectReference, .ReferenceType, .ThreadReference, .VirtualMachine, com.sun.jdi.event.EventQueue, .EventSet, .ExceptionEvent

Request for notification when an exception occurs in the target VM. When an enabled ExceptionRequest is satisfied, an event set containing an ExceptionEvent will be placed on the EventQueue. The collection of existing ExceptionRequests is managed by the EventRequestManager
Author
Robert Field
Since
1.3
See Also
ExceptionEvent, EventQueue, EventRequestManager

Field Summary

Inherited from com.sun.jdi.request.EventRequest:
SUSPEND_ALLSUSPEND_EVENT_THREADSUSPEND_NONE

Method Summary

Modifier and TypeMethod and Description
public void
addClassExclusionFilter(String
the pattern String to filter against.
classPattern
)

Restricts the events generated by this request to those whose location is in a class whose name does not match a restricted regular expression.

public void
addClassFilter(ReferenceType
the reference type to filter on.
refType
)

Restricts the events generated by this request to those whose location is in the given reference type or any of its subtypes.

public void
addClassFilter(String
the pattern String to filter for.
classPattern
)

Restricts the events generated by this request to those whose location is in a class whose name matches a restricted regular expression.

public void
addInstanceFilter(ObjectReference
the object which must be the current instance in order to pass this filter.
instance
)

Restricts the events generated by this request to those in which the currently executing instance ("this") is the object specified.

public void
addThreadFilter(ThreadReference
the thread to filter on.
thread
)

Restricts the events generated by this request to those in the given thread.

public ReferenceType

Returns:

The exception (and its subclasses) requested with EventRequestManager#createExceptionRequest, or null if, as by default, all exceptions are requested.
exception
()

Returns exception type for which exception events are requested.

public boolean

Returns:

boolean true if caught exceptions will be reported, false otherwise.
notifyCaught
()

Returns whether caught exceptions of the requested type will generate events when they are thrown.

public boolean

Returns:

boolean true if caught exceptions will be reported, false otherwise.
notifyUncaught
()

Returns whether uncaught exceptions of the requested type will generate events when they are thrown.

Inherited from com.sun.jdi.request.EventRequest:
addCountFilterdisableenablegetPropertyisEnabledputPropertysetEnabledsetSuspendPolicysuspendPolicy

Method Detail

addClassExclusionFilterback to summary
public void addClassExclusionFilter(String classPattern)

Restricts the events generated by this request to those whose location is in a class whose name does not match a restricted regular expression. Regular expressions are limited to exact matches and patterns that begin with '*' or end with '*'; for example, "*.Foo" or "java.*".

Parameters
classPattern:String

the pattern String to filter against.

Exceptions
InvalidRequestStateException:
if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.
addClassFilterback to summary
public void addClassFilter(ReferenceType refType)

Restricts the events generated by this request to those whose location is in the given reference type or any of its subtypes. An event will be generated for any location in a reference type that can be safely cast to the given reference type.

Parameters
refType:ReferenceType

the reference type to filter on.

Exceptions
InvalidRequestStateException:
if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.
addClassFilterback to summary
public void addClassFilter(String classPattern)

Restricts the events generated by this request to those whose location is in a class whose name matches a restricted regular expression. Regular expressions are limited to exact matches and patterns that begin with '*' or end with '*'; for example, "*.Foo" or "java.*".

Parameters
classPattern:String

the pattern String to filter for.

Exceptions
InvalidRequestStateException:
if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.
addInstanceFilterback to summary
public void addInstanceFilter(ObjectReference instance)

Restricts the events generated by this request to those in which the currently executing instance ("this") is the object specified.

Not all targets support this operation. Use VirtualMachine#canUseInstanceFilters() to determine if the operation is supported.

Parameters
instance:ObjectReference

the object which must be the current instance in order to pass this filter.

Exceptions
UnsupportedOperationException:
if the target virtual machine does not support this operation.
InvalidRequestStateException:
if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.
Since
1.4
addThreadFilterback to summary
public void addThreadFilter(ThreadReference thread)

Restricts the events generated by this request to those in the given thread.

Parameters
thread:ThreadReference

the thread to filter on.

Exceptions
InvalidRequestStateException:
if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.
exceptionback to summary
public ReferenceType exception()

Returns exception type for which exception events are requested.

Returns:ReferenceType

The exception (and its subclasses) requested with EventRequestManager#createExceptionRequest, or null if, as by default, all exceptions are requested.

notifyCaughtback to summary
public boolean notifyCaught()

Returns whether caught exceptions of the requested type will generate events when they are thrown.

Note that at the time an exception is thrown, it is not always possible to determine whether it is truly caught. See ExceptionEvent#catchLocation for details.

Returns:boolean

boolean true if caught exceptions will be reported, false otherwise.

notifyUncaughtback to summary
public boolean notifyUncaught()

Returns whether uncaught exceptions of the requested type will generate events when they are thrown.

Note that at the time an exception is thrown, it is not always possible to determine whether it is truly uncaught. See ExceptionEvent#catchLocation for details.

Returns:boolean

boolean true if caught exceptions will be reported, false otherwise.