Interface StackWalker.StackFrame
- Enclosing class:
- StackWalker
public static interface StackWalker.StackFrame
A 
StackFrame object represents a method invocation returned by
 StackWalker.
  Stack walker options configure the stack
 frame information obtained by a StackWalker.
 If the stack walker is configured with DROP_METHOD_INFO option, method information such as
 the method name,
 the line number,
 the bytecode index, etc
 will be dropped.
 If the stack walker is configured with RETAIN_CLASS_REFERENCE option, the Class object
 will be retained for access.
- See Java Virtual Machine Specification:
- 
2.6 Frames
- Since:
- 9
- 
Method SummaryModifier and TypeMethodDescriptionintReturns the index to the code array of theCodeattribute containing the execution point represented by this stack frame.Returns the binary name of the declaring class of the method represented by this stack frame.Class<?> Returns the declaringClassfor the method represented by this stack frame.default StringReturns the descriptor of the method represented by this stack frame as defined by The Java Virtual Machine Specification.Returns the name of the source file containing the execution point represented by this stack frame.intReturns the line number of the source line containing the execution point represented by this stack frame.Returns the name of the method represented by this stack frame.default MethodTypeReturns theMethodTyperepresenting the parameter types and the return type for the method represented by this stack frame.booleanReturnstrueif the method containing the execution point represented by this stack frame is a native method.ReturnsStackTraceElementfor this stack frame.
- 
Method Details- 
getClassNameString getClassName()Returns the binary name of the declaring class of the method represented by this stack frame.- Returns:
- the binary name of the declaring class of the method represented by this stack frame
- See Java Language Specification:
- 
13.1 The Form of a Binary
 
- 
getMethodNameString getMethodName()Returns the name of the method represented by this stack frame.- Returns:
- the name of the method represented by this stack frame
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
 
- 
getDeclaringClassClass<?> getDeclaringClass()Returns the declaringClassfor the method represented by this stack frame.- Returns:
- the declaring Classfor the method represented by this stack frame
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured without- RETAIN_CLASS_REFERENCEoption
 
- 
getMethodTypeReturns theMethodTyperepresenting the parameter types and the return type for the method represented by this stack frame.- Implementation Requirements:
- The default implementation throws UnsupportedOperationException.
- Returns:
- the MethodTypeof the method represented by this stack frame
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption or without- RETAIN_CLASS_REFERENCEoption
- Since:
- 10
 
- 
getDescriptorReturns the descriptor of the method represented by this stack frame as defined by The Java Virtual Machine Specification.- Implementation Requirements:
- The default implementation throws UnsupportedOperationException.
- Returns:
- the descriptor of the method represented by this stack frame
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
- See Java Virtual Machine Specification:
- 
4.3.3 Method Descriptors
- Since:
- 10
- See Also:
 
- 
getByteCodeIndexint getByteCodeIndex()Returns the index to the code array of theCodeattribute containing the execution point represented by this stack frame. The code array gives the actual bytes of Java Virtual Machine code that implement the method.- Returns:
- the index to the code array of the Codeattribute containing the execution point represented by this stack frame, or a negative number if the method is native.
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
- See Java Virtual Machine Specification:
- 
4.7.3 The CodeAttribute
 
- 
getFileNameString getFileName()Returns the name of the source file containing the execution point represented by this stack frame. Generally, this corresponds to theSourceFileattribute of the relevantclassfile 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.- Returns:
- the name of the file containing the execution point
         represented by this stack frame, or nullif this information is unavailable.
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
- See Java Virtual Machine Specification:
- 
4.7.10 The SourceFileAttribute
 
- 
getLineNumberint getLineNumber()Returns the line number of the source line containing the execution point represented by this stack frame. Generally, this is derived from theLineNumberTableattribute of the relevantclassfile as defined by The Java Virtual Machine Specification.- Returns:
- 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.
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
- See Java Virtual Machine Specification:
- 
4.7.12 The LineNumberTableAttribute
 
- 
isNativeMethodboolean isNativeMethod()Returnstrueif the method containing the execution point represented by this stack frame is a native method.- Returns:
- trueif the method containing the execution point represented by this stack frame is a native method
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
 
- 
toStackTraceElementStackTraceElement toStackTraceElement()ReturnsStackTraceElementfor this stack frame.- Returns:
- StackTraceElementfor this stack frame
- Throws:
- UnsupportedOperationException- if the- StackWalkeris configured with- DROP_METHOD_INFOoption
 
 
-