Save This Page
Home » openjdk-7 » java » lang » [javadoc | source]
java.lang
public final class: StackTraceElement [javadoc | source]
java.lang.Object
   java.lang.StackTraceElement

All Implemented Interfaces:
    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.
Constructor:
 public StackTraceElement(String declaringClass,
    String methodName,
    String 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 {@code 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 - if {@code declaringClass} or {@code methodName} is null
    since: 1.5 -
Method from java.lang.StackTraceElement Summary:
equals,   getClassName,   getFileName,   getLineNumber,   getMethodName,   hashCode,   isNativeMethod,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.lang.StackTraceElement Detail:
 public boolean equals(Object obj) 
    Returns true if the specified object is another {@code StackTraceElement} instance representing the same execution point as this instance. Two stack trace elements {@code a} and {@code 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 {@code equals} has the semantics of Objects.equals .
 public String getClassName() 
    Returns the fully qualified name of the class containing the execution point represented by this stack trace element.
 public String getFileName() 
    Returns the name of the source file containing the execution point represented by this stack trace element. Generally, this corresponds to the {@code SourceFile} attribute of the relevant {@code 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.
 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 {@code LineNumberTable} attribute of the relevant {@code class} file (as per The Java Virtual Machine Specification, Section 4.7.8).
 public 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, {@code } or {@code }, as per Section 3.9 of The Java Virtual Machine Specification.
 public int hashCode() 
    Returns a hash code value for this stack trace element.
 public boolean isNativeMethod() 
    Returns true if the method containing the execution point represented by this stack trace element is a native method.
 public 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:
    • {@code "MyClass.mash(MyClass.java:9)"} - Here, {@code "MyClass"} is the fully-qualified name of the class containing the execution point represented by this stack trace element, {@code "mash"} is the name of the method containing the execution point, {@code "MyClass.java"} is the source file containing the execution point, and {@code "9"} is the line number of the source line containing the execution point.
    • {@code "MyClass.mash(MyClass.java)"} - As above, but the line number is unavailable.
    • {@code "MyClass.mash(Unknown Source)"} - As above, but neither the file name nor the line number are available.
    • {@code "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.