public interface

StepRequest

implements EventRequest
com.sun.jdi.request.StepRequest

Class Overview

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

See Also

Summary

Constants
int STEP_INTO Step into any newly pushed frames
int STEP_LINE Step to the next location on a different line
int STEP_MIN Step to the next available location
int STEP_OUT Step out of the current frame
int STEP_OVER Step over any newly pushed frames
[Expand]
Inherited Constants
From interface com.sun.jdi.request.EventRequest
Public Methods
abstract 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.
abstract 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.
abstract 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.
abstract void addInstanceFilter(ObjectReference instance)
Restricts the events generated by this request to those in which the currently executing instance ("this") is the object specified.
abstract int depth()
abstract int size()
abstract ThreadReference thread()
[Expand]
Inherited Methods
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.request.EventRequest

Constants

public static final int STEP_INTO

Step into any newly pushed frames

Constant Value: 1 (0x00000001)

public static final int STEP_LINE

Step to the next location on a different line

Constant Value: -2 (0xfffffffe)

public static final int STEP_MIN

Step to the next available location

Constant Value: -1 (0xffffffff)

public static final int STEP_OUT

Step out of the current frame

Constant Value: 3 (0x00000003)

public static final int STEP_OVER

Step over any newly pushed frames

Constant Value: 2 (0x00000002)

Public Methods

public abstract 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 the pattern String to filter against.
Throws
InvalidRequestStateException if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.

public abstract 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 the pattern String to filter for.
Throws
InvalidRequestStateException if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.

public abstract 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 the reference type to filter on.
Throws
InvalidRequestStateException if this request is currently enabled or has been deleted. Filters may be added only to disabled requests.

public abstract 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 canUseInstanceFilters() to determine if the operation is supported.

Parameters
instance the object which must be the current instance in order to pass this filter.
Throws
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.

public abstract int depth ()

Returns
  • the step depth

public abstract int size ()

Returns
  • the step size

public abstract ThreadReference thread ()

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