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

public Interface StepRequest

extends EventRequest
Known Direct Implementers
com.sun.tools.jdi.EventRequestManagerImpl.StepRequestImpl
Imports
com.sun.jdi.ObjectReference, .ReferenceType, .ThreadReference, .VirtualMachine, com.sun.jdi.event.EventQueue, .EventSet, .StepEvent
Request for notification when a step occurs in the target VM. When an enabled StepRequest is satisfied, an event set containing a StepEvent will be placed on the EventQueue. The collection of existing StepRequests is managed by the EventRequestManager
Author
Robert Field
Since
1.3
See Also
StepEvent, EventQueue, EventRequestManager

Field Summary

Modifier and TypeField and Description
public static final int
STEP_INTO

Step into any newly pushed frames

public static final int
STEP_LINE

Step to the next location on a different line

public static final int
STEP_MIN

Step to the next available location

public static final int
STEP_OUT

Step out of the current frame

public static final int
STEP_OVER

Step over any newly pushed frames

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 int
depth()

Returns: the step depth

public int
size()

Returns: the step size

public ThreadReference
thread()

Returns: the thread on which the step event is being requested.

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

Field Detail

STEP_INTOback to summary
public static final int STEP_INTO

Step into any newly pushed frames

STEP_LINEback to summary
public static final int STEP_LINE

Step to the next location on a different line

STEP_MINback to summary
public static final int STEP_MIN

Step to the next available location

STEP_OUTback to summary
public static final int STEP_OUT

Step out of the current frame

STEP_OVERback to summary
public static final int STEP_OVER

Step over any newly pushed frames

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
depthback to summary
public int depth()
Returns:int

the step depth

sizeback to summary
public int size()
Returns:int

the step size

threadback to summary
public ThreadReference thread()
Returns:ThreadReference

the thread on which the step event is being requested.