|
Eclipse JDT Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IJavaStackFrame
A stack frame in a thread on a Java virtual machine.
Since 3.1, IJavaStackFrame
also implements
IDropToFrame
.
IStackFrame
Field Summary | |
---|---|
static int |
ERR_INVALID_STACK_FRAME
Status code indicating a stack frame is invalid. |
Method Summary | |
---|---|
boolean |
canForceReturn()
Returns whether this frame currently supports a force return operation. |
IJavaVariable |
findVariable(String variableName)
Returns the local, static, or "this" variable with the given name, or null if unable to resolve a variable with the name. |
void |
forceReturn(IJavaValue value)
Steps out of this frame's method returning the given value. |
List |
getArgumentTypeNames()
Returns a list of fully qualified type names of the arguments for the method associated with this stack frame. |
IJavaClassType |
getDeclaringType()
Deprecated. Use getReferenceType() instead, as a method is not
restricted to occur in a class. An interface may contain a synthetic
class initializer methods. Since 3.1, this method throws a
DebugException when a stack frame's method is contained
in an interface. |
String |
getDeclaringTypeName()
Returns the fully qualified name of the type that declares the method associated with this stack frame. |
int |
getLineNumber(String stratum)
Returns the line number of the instruction pointer in this stack frame that corresponds to the line in the associated source element in the specified stratum, or -1 if line number
information is unavailable. |
IJavaVariable[] |
getLocalVariables()
Returns a collection of local variables that are visible at the current point of execution in this stack frame. |
String |
getMethodName()
Returns the name of the method associated with this stack frame |
String |
getReceivingTypeName()
Returns the fully qualified name of the type that is the receiving object associated with this stack frame |
IJavaReferenceType |
getReferenceType()
Returns the type in which this stack frame's method is declared. |
String |
getSignature()
Returns the JNI signature for the method this stack frame is associated with. |
String |
getSourceName()
Returns the source name debug attribute associated with the declaring type of this stack frame, or null if the source name debug
attribute not present. |
String |
getSourceName(String stratum)
Returns the source name debug attribute associated with the declaring type of this stack frame in the specified stratum, or null
if the source name debug attribute not present. |
String |
getSourcePath()
Returns the source path debug attribute associated with this stack frame, or null if the source path
is not known. |
String |
getSourcePath(String stratum)
Returns the source path debug attribute associated with this stack frame in the specified stratum, or null if the source path is not known. |
IJavaObject |
getThis()
Returns a reference to the receiver of the method associated with this stack frame, or null if this stack frame
represents a static method. |
boolean |
isConstructor()
Returns whether the method associated with this stack frame is a constructor. |
boolean |
isNative()
Returns whether the method associated with this stack frame has been declared as native. |
boolean |
isObsolete()
Returns whether the method associated with this stack frame is obsolete, that is, it is running old byte codes that have been replaced in the VM. |
boolean |
isOutOfSynch()
Returns whether the method associated with this stack frame is running code in the VM that is out of synch with the code in the workspace. |
boolean |
isStaticInitializer()
Returns whether the method associated with this stack frame is a static initializer. |
boolean |
isSynchronized()
Returns whether the method associated with this stack frame has been declared as synchronized. |
boolean |
isVarArgs()
Returns whether the method associated with this stack frame accepts a variable number of arguments. |
boolean |
supportsDropToFrame()
Deprecated. since 3.1, IJavaStackFrame extends org.eclipse.debug.core.IDropToFrame which defines canDropToFrame(). Use this method instead. |
boolean |
wereLocalsAvailable()
Returns whether local variable information was available when local variables were retrieved from the target for this frame. |
Methods inherited from interface org.eclipse.debug.core.model.IStackFrame |
---|
getCharEnd, getCharStart, getLineNumber, getName, getRegisterGroups, getThread, getVariables, hasRegisterGroups, hasVariables |
Methods inherited from interface org.eclipse.debug.core.model.IDebugElement |
---|
getDebugTarget, getLaunch, getModelIdentifier |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.debug.core.model.ISuspendResume |
---|
canResume, canSuspend, isSuspended, resume, suspend |
Methods inherited from interface org.eclipse.debug.core.model.ITerminate |
---|
canTerminate, isTerminated, terminate |
Methods inherited from interface org.eclipse.jdt.debug.core.IJavaModifiers |
---|
isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic |
Methods inherited from interface org.eclipse.debug.core.model.IFilteredStep |
---|
canStepWithFilters, stepWithFilters |
Methods inherited from interface org.eclipse.debug.core.model.IStep |
---|
canStepInto, canStepOver, canStepReturn, isStepping, stepInto, stepOver, stepReturn |
Methods inherited from interface org.eclipse.debug.core.model.IDropToFrame |
---|
canDropToFrame, dropToFrame |
Field Detail |
---|
static final int ERR_INVALID_STACK_FRAME
Method Detail |
---|
boolean supportsDropToFrame()
boolean isConstructor() throws DebugException
DebugException
- if this method fails. Reasons include:
boolean isNative() throws DebugException
DebugException
- if this method fails. Reasons include:
boolean isStaticInitializer() throws DebugException
DebugException
- if this method fails. Reasons include:boolean isSynchronized() throws DebugException
DebugException
- if this method fails. Reasons include:
boolean isOutOfSynch() throws DebugException
DebugException
- if this method fails. Reasons include:
boolean isObsolete() throws DebugException
DebugException
- if this method fails. Reasons include:
String getDeclaringTypeName() throws DebugException
DebugException
- if this method fails. Reasons include:
String getReceivingTypeName() throws DebugException
DebugException
- if this method fails. Reasons include:
String getSignature() throws DebugException
DebugException
- if this method fails. Reasons include:
List getArgumentTypeNames() throws DebugException
DebugException
- if this method fails. Reasons include:
String getMethodName() throws DebugException
DebugException
- if this method fails. Reasons include:
IJavaVariable findVariable(String variableName) throws DebugException
null
if unable to resolve a variable with the name.
variableName
- the name of the variable to search for
null
if none
DebugException
- if this method fails. Reasons include:
int getLineNumber(String stratum) throws DebugException
-1
if line number
information is unavailable.
stratum
- the stratum to use.
-1
if line number information is unavailable
DebugException
- if this method fails. Reasons include:
String getSourceName() throws DebugException
null
if the source name debug
attribute not present.
null
DebugException
- if this method fails. Reasons include:
String getSourceName(String stratum) throws DebugException
null
if the source name debug attribute not present.
stratum
- the stratum to use.
null
DebugException
- if this method fails. Reasons include:
String getSourcePath(String stratum) throws DebugException
null
if the source path is not known.
stratum
- the stratum to use.
null
DebugException
- if this method fails. Reasons include:
String getSourcePath() throws DebugException
null
if the source path
is not known.
null
DebugException
- if this method fails. Reasons include:
IJavaVariable[] getLocalVariables() throws DebugException
DebugException
- if this method fails. Reasons include:
IJavaObject getThis() throws DebugException
null
if this stack frame
represents a static method.
null
DebugException
- if this method fails. Reasons include:
IJavaClassType getDeclaringType() throws DebugException
getReferenceType()
instead, as a method is not
restricted to occur in a class. An interface may contain a synthetic
class initializer methods. Since 3.1, this method throws a
DebugException
when a stack frame's method is contained
in an interface.
DebugException
- if this method fails. Reasons include:
IJavaReferenceType getReferenceType() throws DebugException
DebugException
- if this method fails. Reasons include:
boolean wereLocalsAvailable()
true
if locals have never been
retrieved. This data is available after the fact, since variable
retrieval is expensive.
true
if locals have never been retrievedboolean isVarArgs() throws DebugException
true
if the method associated with this stack
frame accepts a variable number of arguments, false
otherwise.
DebugException
- if this method fails. Reasons include:
boolean canForceReturn()
Force return is only available when a thread is suspended.
void forceReturn(IJavaValue value) throws DebugException
IJavaDebugTarget.voidValue()
).
value
- return value that must be assignment compatible with this frame's
method's return value
DebugException
- if the operation fails
|
Eclipse JDT Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2011 IBM Corporation and others. All rights reserved.