org.netbeans.spi.debugger.jpda
Class Evaluator.Context

java.lang.Object
  org.netbeans.spi.debugger.jpda.Evaluator.Context

Enclosing interface:

Evaluator<PreprocessedInfo>

public static final class Evaluator.Context
extends Object

Context of the evaluation. This class provides the evaluation context - stack frame and context variable. Two sets of APIs can be used during the evaluation:

• JPDA Debugger API (which is a safe abstraction of JDI, but with limited functionality)
  Provided CallStackFrame and ObjectVariable can be used to compute the resulting Variable.
• JDI API (providing full access, but can throw unexpected exceptions and clients must notify the context about method invocations)
  Provided StackFrame and ObjectReference can be used to compute the resulting Value. When a method invocation is necessary, notifyMethodToBeInvoked() must be called before the method invocation.

Constructor Summary

Evaluator.Context(Lookup context)
Creates the context, do not call directly

Method Summary

CallStackFrame	getCallStackFrame() Get the context call stack frame.
com.sun.jdi.ObjectReference	getContextObject() Get an optional context object.
ObjectVariable	getContextVariable() Get an optional context variable.
int	getStackDepth() Get the depth of stack frame returned from getStackFrame().
com.sun.jdi.StackFrame	getStackFrame() Get the context stack frame in JDI APIs.
void	notifyMethodToBeInvoked() This method is required to be called before a call to JDI that cause the current thread (sf.thread()) to resume - e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

Evaluator.Context

public Evaluator.Context(Lookup context)

Creates the context, do not call directly

Method Detail

getCallStackFrame

public CallStackFrame getCallStackFrame()

Get the context call stack frame. This frame corresonds to the JDI frame returned from getStackFrame().

Returns:

call stack frame in which the evaluation is performed

getContextVariable

public ObjectVariable getContextVariable()

Get an optional context variable. When non-null, all methods and fields should be treated relative to the variable instance. This variable corresonds to the JDI reference returned from getContextObject().

Returns:

optional context variable or null.

getStackFrame

public com.sun.jdi.StackFrame getStackFrame()

Get the context stack frame in JDI APIs. This frame corresonds to the JPDA frame returned from getCallStackFrame().

Returns:

stack frame in which the evaluation is performed

getStackDepth

public int getStackDepth()

Get the depth of stack frame returned from getStackFrame().

Returns:

the depth of stack frame

getContextObject

public com.sun.jdi.ObjectReference getContextObject()

Get an optional context object. When non-null, all methods and fields should be treated relative to the object instance. This object corresonds to the JPDA variable returned from getContextVariable().

Returns:

optional context object or null.

notifyMethodToBeInvoked

public void notifyMethodToBeInvoked()

This method is required to be called before a call to JDI that cause the current thread (sf.thread()) to resume - e.g. ObjectReference.invokeMethod(com.sun.jdi.ThreadReference, com.sun.jdi.Method, java.util.List, int), ClassType.invokeMethod(com.sun.jdi.ThreadReference, com.sun.jdi.Method, java.util.List, int), ClassType.newInstance(com.sun.jdi.ThreadReference, com.sun.jdi.Method, java.util.List, int).