Package com.github.toolarium.common.stacktrace

Class StackTraceElement

  • All Implemented Interfaces:
    java.io.Serializable
    public final class StackTraceElement
extends java.lang.Object
implements java.io.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:
    Serialized Form

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getClassName()
      Returns the fully qualified name of the class containing the execution point represented by this stack trace element.
      java.lang.String getFileName()
      Returns the name of the source file containing the execution point represented by this stack trace element.
      java.lang.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.
      java.lang.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.
      java.lang.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 Detail

      • StackTraceElement

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

      • StackTraceElement

        public StackTraceElement​(java.lang.String header,
                         java.lang.String declaringClass,
                         java.lang.String fileName,
                         java.lang.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 Detail

      • getHeader

        public java.lang.String getHeader()
        Returns the header
        Returns:
        the header

      • getFileName

        public java.lang.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 java.lang.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 java.lang.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 java.lang.Object
        See Also:
        Object.hashCode()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)

      • toString

        public java.lang.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 java.lang.Object
        Returns:
        the string representation