Added in API level 34

StackFrame

interface StackFrame

java.lang.StackWalker.StackFrame

A StackFrame object represents a method invocation returned by StackWalker.

The getDeclaringClass() method may be unsupported as determined by the stack walking options of a stack walker.

Summary

Public methods
abstract Int	getByteCodeIndex() Returns the index to the insns array of a code_item containing the execution point represented by this stack frame.
abstract String!	getClassName() Gets the binary name of the declaring class of the method represented by this stack frame.
abstract Class<*>!	getDeclaringClass() Gets the declaring Class for the method represented by this stack frame.
open String!	getDescriptor() Returns the descriptor of the method represented by this stack frame as defined by The Java Virtual Machine Specification.
abstract String!	getFileName() Returns the name of the source file containing the execution point represented by this stack frame.
abstract Int	getLineNumber() Returns the line number of the source line containing the execution point represented by this stack frame.
abstract String!	getMethodName() Gets the name of the method represented by this stack frame.
open MethodType!	getMethodType() Returns the MethodType representing the parameter types and the return type for the method represented by this stack frame.
abstract Boolean	isNativeMethod() Returns true if the method containing the execution point represented by this stack frame is a native method.
abstract StackTraceElement!	toStackTraceElement() Gets a StackTraceElement for this stack frame.

Public methods

getByteCodeIndex

Added in API level 34

abstract fun getByteCodeIndex(): Int

Returns the index to the insns array of a code_item containing the execution point represented by this stack frame. The code array gives the actual bytes of Dalvik bytecode that implement the method.

Return
Int	the index to the insns array of the code_item attribute containing the execution point represented by this stack frame, or a negative number if the method is native.

getClassName

Added in API level 34

abstract fun getClassName(): String!

Gets the binary name of the declaring class of the method represented by this stack frame.

Return
String!	the binary name of the declaring class of the method represented by this stack frame

getDeclaringClass

Added in API level 34

abstract fun getDeclaringClass(): Class<*>!

Gets the declaring Class for the method represented by this stack frame.

Return
Class<*>!	the declaring Class of the method represented by this stack frame

Exceptions
java.lang.UnsupportedOperationException	if this StackWalker is not configured with Option.RETAIN_CLASS_REFERENCE.

getDescriptor

Added in API level 34

open fun getDescriptor(): String!

Returns the descriptor of the method represented by this stack frame as defined by The Java Virtual Machine Specification.

Return
String!	the descriptor of the method represented by this stack frame

See Also

• java.lang.invoke.MethodType#fromMethodDescriptorString(String, ClassLoader)
• java.lang.invoke.MethodType#toMethodDescriptorString()

getFileName

Added in API level 34

abstract fun getFileName(): String!

Returns the name of the source file containing the execution point represented by this stack frame. Generally, this corresponds to the SourceFile attribute of the relevant class file as defined by The Java Virtual Machine Specification. In some systems, the name may refer to some source code unit other than a file, such as an entry in a source repository.

Return
String!	the name of the file containing the execution point represented by this stack frame, or null if this information is unavailable.

getLineNumber

Added in API level 34

abstract fun getLineNumber(): Int

Returns the line number of the source line containing the execution point represented by this stack frame. Generally, this is derived from the LineNumberTable attribute of the relevant class file as defined by The Java Virtual Machine Specification.

Return
Int	the line number of the source line containing the execution point represented by this stack frame, or a negative number if this information is unavailable.

getMethodName

Added in API level 34

abstract fun getMethodName(): String!

Gets the name of the method represented by this stack frame.

Return
String!	the name of the method represented by this stack frame

getMethodType

Added in API level 34

open fun getMethodType(): MethodType!

Returns the MethodType representing the parameter types and the return type for the method represented by this stack frame.

Return
MethodType!	the MethodType for this stack frame

Exceptions
java.lang.UnsupportedOperationException	if this StackWalker is not configured with Option.RETAIN_CLASS_REFERENCE.

isNativeMethod

Added in API level 34

abstract fun isNativeMethod(): Boolean

Returns true if the method containing the execution point represented by this stack frame is a native method.

Return
Boolean	true if the method containing the execution point represented by this stack frame is a native method.

toStackTraceElement

Added in API level 34

abstract fun toStackTraceElement(): StackTraceElement!

Gets a StackTraceElement for this stack frame.

Return
StackTraceElement!	StackTraceElement for this stack frame.