Skip to content

Most visited

Recently visited

navigation

StackTraceElement

public final class StackTraceElement
extends Object implements Serializable

java.lang.Object
   ↳ java.lang.StackTraceElement


An element in a stack trace, as returned by getStackTrace(). Each element represents a single stack frame. All stack frames except for the one at the top of the stack represent a method invocation. The frame at the top of the stack represents the execution point at which the stack trace was generated. Typically, this is the point at which the throwable corresponding to the stack trace was created.

Summary

Public constructors

StackTraceElement(String declaringClass, String methodName, String fileName, int lineNumber)

Creates a stack trace element representing the specified execution point.

Public methods

boolean equals(Object obj)

Returns true if the specified object is another StackTraceElement instance representing the same execution point as this instance.

String getClassName()

Returns the fully qualified name of the class containing the execution point represented by this stack trace element.

String getFileName()

Returns the name of the source file containing the execution point represented by this stack trace element.

int getLineNumber()

Returns the line number of the source line containing the execution point represented by this stack trace element.

String getMethodName()

Returns the name of the method containing the execution point represented by this stack trace element.

int hashCode()

Returns a hash code value for this stack trace element.

boolean isNativeMethod()

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

String toString()

Returns a string representation of this stack trace element.

Inherited methods

From class java.lang.Object

Public constructors

StackTraceElement

Added in API level 1
StackTraceElement (String declaringClass, 
                String methodName, 
                String fileName, 
                int lineNumber)

Creates a stack trace element representing the specified execution point.

Parameters
declaringClass String: the fully qualified name of the class containing the execution point represented by the stack trace element
methodName String: the name of the method containing the execution point represented by the stack trace element
fileName String: the name of the file containing the execution point represented by the stack trace element, or null if this information is unavailable
lineNumber int: the line number of the source line containing the execution point represented by this stack trace element, or a negative number if this information is unavailable. A value of -2 indicates that the method containing the execution point is a native method
Throws
NullPointerException if declaringClass or methodName is null

Public methods

equals

Added in API level 1
boolean equals (Object obj)

Returns true if the specified object is another StackTraceElement instance representing the same execution point as this instance. Two stack trace elements a and b are equal if and only if:

     equals(a.getFileName(), b.getFileName()) &&
     a.getLineNumber() == b.getLineNumber()) &&
     equals(a.getClassName(), b.getClassName()) &&
     equals(a.getMethodName(), b.getMethodName())
 
where equals has the semantics of Objects.equals.

Parameters
obj Object: the object to be compared with this stack trace element.
Returns
boolean true if the specified object is another StackTraceElement instance representing the same execution point as this instance.

getClassName

Added in API level 1
String getClassName ()

Returns the fully qualified name of the class containing the execution point represented by this stack trace element.

Returns
String the fully qualified name of the Class containing the execution point represented by this stack trace element.

getFileName

Added in API level 1
String getFileName ()

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

Returns
String the name of the file containing the execution point represented by this stack trace element, or null if this information is unavailable.

getLineNumber

Added in API level 1
int getLineNumber ()

Returns the line number of the source line containing the execution point represented by this stack trace element. Generally, this is derived from the LineNumberTable attribute of the relevant class file (as per The Java Virtual Machine Specification, Section 4.7.8).

Returns
int the line number of the source line containing the execution point represented by this stack trace element, or a negative number if this information is unavailable.

getMethodName

Added in API level 1
String getMethodName ()

Returns the name of the method containing the execution point represented by this stack trace element. If the execution point is contained in an instance or class initializer, this method will return the appropriate special method name, <init> or <clinit>, as per Section 3.9 of The Java Virtual Machine Specification.

Returns
String the name of the method containing the execution point represented by this stack trace element.

hashCode

Added in API level 1
int hashCode ()

Returns a hash code value for this stack trace element.

Returns
int a hash code value for this object.

isNativeMethod

Added in API level 1
boolean isNativeMethod ()

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

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

toString

Added in API level 1
String toString ()

Returns a string representation of this stack trace element. The format of this string depends on the implementation, but the following examples may be regarded as typical:

  • "MyClass.mash(MyClass.java:9)" - Here, "MyClass" is the fully-qualified name of the class containing the execution point represented by this stack trace element, "mash" is the name of the method containing the execution point, "MyClass.java" is the source file containing the execution point, and "9" is the line number of the source line containing the execution point.
  • "MyClass.mash(MyClass.java)" - As above, but the line number is unavailable.
  • "MyClass.mash(Unknown Source)" - As above, but neither the file name nor the line number are available.
  • "MyClass.mash(Native Method)" - As above, but neither the file name nor the line number are available, and the method containing the execution point is known to be a native method.

Returns
String a string representation of the object.

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.