APIdia Launch Partner
Top Description Fields Methods
com.sun.jdi.request

public Interface ClassPrepareRequest

extends EventRequest
Known Direct Implementers
com.sun.tools.jdi.EventRequestManagerImpl.ClassPrepareRequestImpl
Imports
com.sun.jdi.ReferenceType, .VirtualMachine, com.sun.jdi.event.ClassPrepareEvent, .EventQueue, .EventSet
Request for notification when a class is prepared in the target VM. When an enabled ClassPrepareRequest is satisfied, an event set containing a ClassPrepareEvent will be placed on the EventQueue. The collection of existing ClassPrepareRequests is managed by the EventRequestManager

Class preparation is defined in the Java Virtual Machine Specification.

Author
Robert Field
Since
1.3
See Also
ClassPrepareEvent, 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 the preparation of reference types whose name does not match this restricted regular expression.

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

Restricts the events generated by this request to be the preparation of the given reference type and any subtypes.

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

Restricts the events generated by this request to the preparation of reference types whose name matches this restricted regular expression.

public void
addSourceNameFilter(String
the pattern string to filter for.
sourceNamePattern)

Restricts the events generated by this request to the preparation of reference types for which the restricted regular expression 'sourceNamePattern' matches one of the 'sourceNames' for the reference type being prepared.

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 the preparation of reference types whose name does not match this 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 be the preparation of the given reference type and any subtypes. An event will be generated for any prepared 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 the preparation of reference types whose name matches this 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.
addSourceNameFilterback to summary
public void addSourceNameFilter(String sourceNamePattern)

Restricts the events generated by this request to the preparation of reference types for which the restricted regular expression 'sourceNamePattern' matches one of the 'sourceNames' for the reference type being prepared. That is, if refType is the ReferenceType being prepared, then there exists at least one stratum, call it 'someStratum' on the list returned by refType.availableStrata(); such that a name on the list returned by refType.sourceNames(someStratam) matches 'sourceNamePattern'. Regular expressions are limited to exact matches and patterns that begin with '*' or end with '*'; for example, "*.Foo" or "java.*".

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

Parameters
sourceNamePattern:String

the pattern string to filter for.

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.6