Package com.github.toolarium.common.stacktrace

Class StackTraceElement

java.lang.Object
com.github.toolarium.common.stacktrace.StackTraceElement
All Implemented Interfaces:
Serializable
public final class StackTraceElement extends Object implements Serializable
An element in a stack trace. 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 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.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    StackTraceElement(StackTraceElement e)
    Default constructor for StackTraceElement
    StackTraceElement(String header, String declaringClass, String fileName, String methodName, int lineNumber)
    Default constructor for StackTraceElement

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    String
    getHeader()
    Returns the header
    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()
     
    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

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • StackTraceElement

      public StackTraceElement(StackTraceElement e)
      Default constructor for StackTraceElement
      Parameters:
      e - the java stack trace element

    • StackTraceElement

      public StackTraceElement(String header, String declaringClass, String fileName, String methodName, int lineNumber)
      Default constructor for StackTraceElement
      Parameters:
      header - the header
      declaringClass - the declaring class
      fileName - the file name
      methodName - the method name
      lineNumber - the line number

  • Method Details

    • getHeader

      public String getHeader()
      Returns the header
      Returns:
      the header

    • getFileName

      public String getFileName()
      Returns the name of the source file containing the execution point represented by this stack trace element.
      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 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 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.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:

    • toString

      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:
      • "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 in class Object
      Returns:
      the string representation