java.lang
Class StackTraceElement
- java.lang.Object
-
- java.lang.StackTraceElement
-
public final class StackTraceElement extends Object
A representation of a single stack frame. Arrays ofStackTraceElement
are stored inThrowable
objects to represent the whole state of the call stack at the time aThrowable
gets thrown.- Since:
- 1.4
- See Also:
Throwable.getStackTrace()
-
-
Constructor Summary
Constructors Constructor and Description StackTraceElement(String cls, String method, String file, int line)
Constructs a newStackTraceElement
for a specified execution point.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.String
getClassName()
Returns the fully qualified name of the class belonging to thisStackTraceElement
.String
getFileName()
Returns the name of the Java source file containing class belonging to thisStackTraceElement
.int
getLineNumber()
Returns the line number in the source for the class belonging to thisStackTraceElement
.String
getMethodName()
Returns the name of the method belonging to thisStackTraceElement
.int
hashCode()
Returns an integer hash code for this object.boolean
isNativeMethod()
Indicates if the method name returned bygetMethodName()
is implemented as a native method.String
toString()
Returns a string containing a concise, human-readable description of this object.
-
-
-
Constructor Detail
-
StackTraceElement
public StackTraceElement(String cls, String method, String file, int line)
Constructs a newStackTraceElement
for a specified execution point.- Parameters:
cls
- the fully qualified name of the class where execution is at.method
- the name of the method where execution is at.file
- The name of the file where execution is at ornull
.line
- the line of the file where execution is at, a negative number if unknown or-2
if the execution is in a native method.- Throws:
NullPointerException
- ifcls
ormethod
isnull
.- Since:
- 1.5
-
-
Method Detail
-
equals
public boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal. In order to be equal, the following conditions must be fulfilled:obj
must be a stack trace element,- the method names of this stack trace element and of
obj
must not benull
, - the class, method and file names as well as the line number of this
stack trace element and of
obj
must be equal.
- Overrides:
equals
in classObject
- Parameters:
obj
- the object to compare this instance with.- Returns:
true
if the specified object is equal to thisStackTraceElement
;false
otherwise.- See Also:
hashCode()
-
getClassName
public String getClassName()
Returns the fully qualified name of the class belonging to thisStackTraceElement
.- Returns:
- the fully qualified type name of the class
-
getFileName
public String getFileName()
Returns the name of the Java source file containing class belonging to thisStackTraceElement
.- Returns:
- the name of the file, or
null
if this information is not available.
-
getLineNumber
public int getLineNumber()
Returns the line number in the source for the class belonging to thisStackTraceElement
.- Returns:
- the line number, or a negative number if this information is not available.
-
getMethodName
public String getMethodName()
Returns the name of the method belonging to thisStackTraceElement
.- Returns:
- the name of the method, or "
" if this information is not available.
-
hashCode
public int hashCode()
Description copied from class:Object
Returns an integer hash code for this object. By contract, any two objects for whichequals(Object)
returnstrue
must return the same hash code value. This means that subclasses ofObject
usually override both methods or neither method.- Overrides:
hashCode
in classObject
- Returns:
- this object's hash code.
- See Also:
Object.equals(java.lang.Object)
-
isNativeMethod
public boolean isNativeMethod()
Indicates if the method name returned bygetMethodName()
is implemented as a native method.- Returns:
true
if the method in which this stack trace element is executing is a native method;false
otherwise.
-
toString
public String toString()
Description copied from class:Object
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object'sObject.hashCode()
, that is, it is equivalent to the following expression:getClass().getName() + '@' + Integer.toHexString(hashCode())
-
-