StackTraceElement (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.lang.StackTraceElement
All Implemented Interfaces:
Serializable

public final class StackTraceElement
extends Object
implements Serializable
An element in a stack trace, as returned by Throwable.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.
Since:
1.4
See Also:
Serialized Form

Constructor Summary

Constructors

Constructor	Description
StackTraceElement(String declaringClass,String methodName,String fileName, int lineNumber)	Creates a stack trace element representing the specified execution point.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if the specified object is anotherStackTraceElement 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.

   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### StackTraceElement  
 public StackTraceElement([String](../../java/lang/String.html "class in java.lang") declaringClass,  
                          [String](../../java/lang/String.html "class in java.lang") methodName,  
                          [String](../../java/lang/String.html "class in java.lang") fileName,  
                          int lineNumber)  
 Creates a stack trace element representing the specified execution point.  
 Parameters:  
 `declaringClass` \- the fully qualified name of the class containing the execution point represented by the stack trace element  
 `methodName` \- the name of the method containing the execution point represented by the stack trace element  
 `fileName` \- the name of the file containing the execution point represented by the stack trace element, or `null` if this information is unavailable  
 `lineNumber` \- 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](../../java/lang/NullPointerException.html "class in java.lang")` \- if `declaringClass` or`methodName` is null  
 Since:  
 1.5

Method Detail

* #### getFileName  
public [String](../../java/lang/String.html "class in java.lang") 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:  
the name of the file containing the execution point represented by this stack trace element, or `null` if this information is unavailable.  
* #### getLineNumber  
public 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:  
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.  
* #### getClassName  
public [String](../../java/lang/String.html "class in java.lang") getClassName()  
Returns the fully qualified name of the class containing the execution point represented by this stack trace element.  
Returns:  
the fully qualified name of the `Class` containing the execution point represented by this stack trace element.  
* #### getMethodName  
public [String](../../java/lang/String.html "class in java.lang") 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:  
the name of the method containing the execution point represented by this stack trace element.  
* #### isNativeMethod  
public boolean isNativeMethod()  
Returns true if the method containing the execution point represented by this stack trace element is a native method.  
Returns:  
`true` if the method containing the execution point represented by this stack trace element is a native method.  
* #### toString  
public [String](../../java/lang/String.html "class in java.lang") 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.  
Overrides:  
`[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a string representation of the object.  
See Also:  
[Throwable.printStackTrace()](../../java/lang/Throwable.html#printStackTrace--)  
* #### equals  
public boolean equals([Object](../../java/lang/Object.html "class in java.lang") 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](../../java/util/Objects.html#equals-java.lang.Object-java.lang.Object-).  
Overrides:  
`[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Parameters:  
`obj` \- the object to be compared with this stack trace element.  
Returns:  
true if the specified object is another`StackTraceElement` instance representing the same execution point as this instance.  
See Also:  
[Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
* #### hashCode  
public int hashCode()  
Returns a hash code value for this stack trace element.  
Overrides:  
`[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a hash code value for this object.  
See Also:  
[Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

StackTraceElement (Java Platform SE 8 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail