org.netbeans.spi.debugger.jpda

Class SmartSteppingCallback

java.lang.Object

org.netbeans.spi.debugger.jpda.SmartSteppingCallback

public abstract class SmartSteppingCallback
extends Object

Listens on stepping engine and defines classes / places the debugger can stop in.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SmartSteppingCallback.Registration Declarative registration of a SmartSteppingCallback implementation.
static class	SmartSteppingCallback.StopOrStep Information about a possibility to stop at the given location, or suggestion to perform a step.

Constructor Summary

Constructors

Constructor and Description
SmartSteppingCallback()

Method Summary

Modifier and Type	Method and Description
abstract void	initFilter(SmartSteppingFilter f) Defines default set of smart stepping filters.
SmartSteppingCallback.StopOrStep	stopAt(ContextProvider lookupProvider, CallStackFrame frame, SmartSteppingFilter f) This is an enhanced version of former SmartSteppingCallback.stopHere(org.netbeans.spi.debugger.ContextProvider, org.netbeans.api.debugger.jpda.JPDAThread, org.netbeans.api.debugger.jpda.SmartSteppingFilter) method, which is called during stepping through debugged application.
abstract boolean	stopHere(ContextProvider lookupProvider, JPDAThread thread, SmartSteppingFilter f) This method is called during stepping through debugged application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartSteppingCallback

public SmartSteppingCallback()

Method Detail

initFilter

public abstract void initFilter(SmartSteppingFilter f)

Defines default set of smart stepping filters. Method is called when a new JPDA debugger session is created.

Parameters:

f - a filter to be initialized

stopHere

public abstract boolean stopHere(ContextProvider lookupProvider,
                                 JPDAThread thread,
                                 SmartSteppingFilter f)

This method is called during stepping through debugged application. The execution is stopped when all registered SmartSteppingCallbacks returns true.

The SmartSteppingFilter instance is unique per step. Any changes to it applies to one ongoing step only. Use JPDADebugger.getSmartSteppingFilter() to make persistent changes.

Parameters:

thread - contains all available information about current position in debugged application

f - a filter, unique to the ongoing step

Returns:

true if execution should be stopped on the current position

stopAt

public SmartSteppingCallback.StopOrStep stopAt(ContextProvider lookupProvider,
                                               CallStackFrame frame,
                                               SmartSteppingFilter f)

This is an enhanced version of former SmartSteppingCallback.stopHere(org.netbeans.spi.debugger.ContextProvider, org.netbeans.api.debugger.jpda.JPDAThread, org.netbeans.api.debugger.jpda.SmartSteppingFilter) method, which is called during stepping through debugged application. The frame argument allows this method to be called for specific stack frames, to check if the execution could be suspended there. This is valuable e.g. for step out. When a top frame is provided, this method can suggest a specific step to continue with, in case it's not possible to stop at the given location.

The SmartSteppingFilter instance is unique per step. Any changes to it applies to one ongoing step only. Register a SmartSteppingFilter implementation to make persistent changes. The default implementation calls SmartSteppingCallback.stopHere(org.netbeans.spi.debugger.ContextProvider, org.netbeans.api.debugger.jpda.JPDAThread, org.netbeans.api.debugger.jpda.SmartSteppingFilter) when called with a top frame and throws an UnsupportedOperationException otherwise.

Parameters:

lookupProvider - The debugger services lookup

frame - The frame in question

f - a filter, unique to the ongoing step

Returns:

whether the debugger can stop at this location, or whether it should continue with a step.

Since:

3.5